Struct Hooks 

pub struct Hooks { /* private fields */ }

General-purpose hooks system for TUI widget state management.

Stores persistent state, SDK watch handles, and animation registrations. Uses mark-and-sweep to automatically clean up state when widgets stop rendering (e.g., screen transitions).

Implementations

impl Hooks

pub fn new() -> Self

pub fn begin_frame(&mut self)

Reset access tracking before a render frame.

pub fn end_frame(&mut self)

Evict unaccessed state and drop unaccessed watch handles.

pub fn use_state<V: 'static>( &mut self, key: &str, default: impl FnOnce() -> V, ) -> &mut V

Get or create persistent local state.

On first call for a given key, creates the state using default(). On subsequent calls, returns the existing state.

Must be called last — the returned &mut V borrows &mut self, preventing other hook calls until the reference is dropped.

pub fn use_watch<P>(&mut self, prop: &PropertyHandle<P>) -> Option<P>

where P: SonosProperty + Clone + 'static,

Subscribe to an SDK speaker property, returning the current value.

Each frame, creates a fresh WatchHandle via prop.watch() to get an up-to-date snapshot. The old handle is replaced (dropped → grace period starts → new handle re-acquires → grace period cancelled). This is the SDK’s intended pattern: “Re-watch each frame to refresh the snapshot.”

Falls back to prop.get() if watch() fails.

pub fn use_watch_group<P>(&mut self, prop: &GroupPropertyHandle<P>) -> Option<P>

where P: SonosProperty + Clone + 'static,

Subscribe to an SDK group property, returning the current value.

Same as use_watch but for group-scoped properties (e.g., group volume).

pub fn use_animation(&mut self, key: &str, active: bool)

Register an animation tick request.

When active is true, the event loop’s global animation timer will mark the app as dirty every ~250ms, triggering re-renders for smooth progress bar animation.

pub fn has_active_animations(&self) -> bool

Check if any widget has registered an active animation.

Called by the event loop between frames to decide whether to tick the animation timer.

Trait Implementations

impl Default for Hooks

fn default() -> Self

Returns the “default value” for a type.