Skip to main content

Module types

Module types 

Source

Structs§

BreakEvent
Payload emitted to the renderer when a break starts.
BreathPattern
A guided breathing pattern, animated on the countdown ring. Phase durations are absolute seconds — tempo is never scaled to the break length; the cycle simply repeats. cycles optionally caps the guided portion, after which then decides whether to loop or rest. A routine carrying a breath takes the place of step text on the overlay.
BreathSounds
Per-phase sound cues for a breathing pattern, so a user can follow the rhythm with their eyes closed. Each is an audio asset id (rewritten to the stored sidecar path on install); any phase may be silent.
LastBreakInfo
The most recently skipped or postponed break, or None if none yet in this session. Powers the tray’s “Resume last skipped break” item.
MonitorRect
Pixel rectangle for a monitor in the desktop’s coordinate space. Used to position overlay windows. Origin can be negative on multi-monitor setups where the primary is not the top-left display.
PostponeState
Per-break postpone budget exposed to the renderer.
RoutineStep
One step of a guided break routine: a short instruction the overlay shows for seconds before advancing to the next step. Part of the break:start wire payload; the routine library that produces these lives in super::routines.

Enums§

BreakDelivery
How a break surfaces to the user. Driven by per-kind settings (micro_break_mode / long_break_mode).
BreakKind
Which kind of break a scheduled event represents.
BreathThen
What a breathing routine does once its cycles cap is reached.
RoutinePacing
How a routine’s step durations relate to the break length. Sent in BreakEvent as the routine’s own declared pacing (if any); the frontend falls back to the routine_fill global setting when this is absent.
SuppressReason
Which auto-suppression rule is currently silencing breaks, exposed to the tray so the user can tell why the icon is inactive.