Skip to main content

Hooks

Struct Hooks 

Source
pub struct Hooks { /* private fields */ }
Expand description

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§

Source§

impl Hooks

Source

pub fn new() -> Self

Source

pub fn begin_frame(&mut self)

Reset access tracking before a render frame.

Source

pub fn end_frame(&mut self)

Evict unaccessed state and drop unaccessed watch handles.

Handles for widgets that rendered this frame are retained, so a continuously-visible widget holds one subscription for its whole life.

Source

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.

Source

pub fn use_watch<P>(&mut self, prop: &PropertyHandle<P>) -> Option<P>
where P: SonosProperty + Clone + 'static,

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

The subscription is acquired on first access and held until the widget stops rendering (mark-and-sweep in Self::end_frame).

Source

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 its current value.

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

Source

pub fn use_watch_group_or_fetch<P>( &mut self, prop: &GroupPropertyHandle<P>, ) -> Option<P>
where P: SonosProperty + GroupFetchable + Clone + 'static,

Subscribe to a fetchable group property, fetching on first access if empty.

Like use_watch_group but performs a one-time fetch when the cache has no value yet, so the UI doesn’t show a blank until the first UPnP event. The fetch happens only on the frame that acquires the handle, since later frames reuse it.

Source

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.

Source

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§

Source§

impl Default for Hooks

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Hooks

§

impl !Send for Hooks

§

impl !Sync for Hooks

§

impl !UnwindSafe for Hooks

§

impl Freeze for Hooks

§

impl Unpin for Hooks

§

impl UnsafeUnpin for Hooks

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more