Skip to main content

ToastManager

Struct ToastManager 

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

A bounded in-window toast queue with exact one-shot auto-dismissal.

The manager owns no timer. It reports the single next deadline through Self::next_deadline so the application sleeps exactly once with crate::AsyncViewContext::sleep_until and then calls Self::expire. An empty or fully paused queue reports no deadline at all, so a settled window keeps zero idle sources.

Implementations§

Source§

impl ToastManager

Source

pub const fn new() -> Self

Source

pub fn timeout(self, timeout: Duration) -> Self

Replace the auto-dismiss duration a queued toast inherits, Base UI’s Provider timeout.

A toast that declares its own Toast::duration or Toast::persistent keeps it. The value is clamped to MAX_TOAST_DURATION.

Source

pub fn limit(self, limit: usize) -> Self

Replace how many toasts stay unlimited, Base UI’s Provider limit.

The newest limit toasts are ordinary; every older one is flagged ToastEntry::is_limited so the application can collapse it behind the stack. Limited toasts still announce and still count down. A limit of zero is treated as one.

Source

pub const fn swipe_direction(self, direction: ToastSwipeDirection) -> Self

Choose the direction a swipe dismisses a toast, Base UI’s swipeDirection.

Source

pub fn swipe_threshold(self, threshold: f32) -> Self

Set how far a swipe must travel before it dismisses, in logical pixels.

Source

pub const fn timeout_value(&self) -> Duration

The auto-dismiss duration a queued toast inherits.

Source

pub const fn limit_value(&self) -> usize

How many toasts stay unlimited.

Source

pub const fn swipe_direction_value(&self) -> ToastSwipeDirection

The direction a swipe dismisses a toast.

Source

pub const fn swipe_threshold_value(&self) -> f32

How far a swipe must travel before it dismisses.

Source

pub const fn is_expanded(&self) -> bool

Whether the viewport is showing its stack expanded, Base UI’s expanded state.

Source

pub fn set_expanded(&mut self, expanded: bool) -> bool

Expand or collapse the stack, returning whether it changed.

A viewport normally expands while it is hovered or holds focus. QuickGUI keeps this an explicit application decision so it never fights a product’s own motion.

Source

pub fn entries(&self) -> &[ToastEntry]

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn entry(&self, id: ToastId) -> Option<&ToastEntry>

Source

pub fn push(&mut self, toast: Toast, now: Instant) -> ToastId

Queue one toast, returning its stable identity.

Reaching MAX_TOASTS drops the oldest toast rather than growing the queue.

Source

pub fn add(&mut self, toast: Toast, now: Instant) -> ToastId

Queue one toast, Base UI’s manager add.

This is Self::push under Base UI’s name; both stay supported.

Source

pub fn update(&mut self, id: ToastId, toast: Toast, now: Instant) -> bool

Replace one queued toast’s content and re-arm its countdown, Base UI’s manager update.

The identity, its position in the stack, and any swipe in flight are preserved, so a progress message can become a result without the toast jumping or re-announcing as new. Returns whether the toast was queued.

Source

pub fn close(&mut self, id: ToastId) -> bool

Remove one toast, Base UI’s manager close.

This is Self::dismiss under Base UI’s name; both stay supported.

Source

pub fn close_all(&mut self) -> bool

Remove every toast, Base UI’s manager close with no identity.

This is Self::clear under Base UI’s name; both stay supported.

Source

pub fn promise(&mut self, loading: impl Into<Arc<str>>, now: Instant) -> ToastId

Queue a persistent loading toast for work the application has just started.

This is the first half of Base UI’s promise helper: QuickGUI owns no future, so the application resolves the same identity with Self::resolve from whichever foreground task it already spawned. Nothing here schedules a timer.

Source

pub fn resolve(&mut self, id: ToastId, resolved: Toast, now: Instant) -> bool

Resolve a toast queued by Self::promise into its success or error result.

This is Self::update named for the promise flow; the identity and stack position are preserved and the countdown restarts from now.

Source

pub fn dismiss(&mut self, id: ToastId) -> bool

Remove one toast, returning whether it was queued.

Source

pub fn clear(&mut self) -> bool

Remove every toast, returning whether the queue changed.

Source

pub fn pause(&mut self, id: ToastId, now: Instant) -> bool

Pause one toast’s countdown on hover or focus, returning whether it changed.

Source

pub fn resume(&mut self, id: ToastId, now: Instant) -> bool

Resume one paused toast’s countdown, returning whether it changed.

Source

pub fn next_deadline(&self) -> Option<Instant>

The single next auto-dismiss instant across the queue.

Source

pub fn expire(&mut self, now: Instant) -> bool

Remove every toast whose exact deadline has passed, returning whether the queue changed.

Source

pub fn apply_swipe( &mut self, id: ToastId, event: &PointerEvent, ) -> ToastSwipeChange

Apply one captured pointer event from a toast root’s swipe gesture.

This is Base UI’s swipe-to-dismiss: motion is projected onto the declared Self::swipe_direction and exposed through ToastEntry::swipe_movement so the application translates the toast itself. Releasing past Self::swipe_threshold dismisses it; releasing short resets the movement to zero and leaves the toast queued.

The gesture is pure pointer capture and schedules nothing. Motion away from the direction is clamped at zero, so a toast can never be dragged the wrong way.

Trait Implementations§

Source§

impl Clone for ToastManager

Source§

fn clone(&self) -> ToastManager

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ToastManager

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ToastManager

Source§

fn default() -> Self

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

impl PartialEq for ToastManager

Source§

fn eq(&self, other: &ToastManager) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ToastManager

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Action for T
where T: Clone + PartialEq + 'static,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryClone for T
where T: Clone,

Source§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
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<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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