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
impl ToastManager
pub const fn new() -> Self
Sourcepub fn timeout(self, timeout: Duration) -> Self
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.
Sourcepub fn limit(self, limit: usize) -> Self
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.
Sourcepub const fn swipe_direction(self, direction: ToastSwipeDirection) -> Self
pub const fn swipe_direction(self, direction: ToastSwipeDirection) -> Self
Choose the direction a swipe dismisses a toast, Base UI’s swipeDirection.
Sourcepub fn swipe_threshold(self, threshold: f32) -> Self
pub fn swipe_threshold(self, threshold: f32) -> Self
Set how far a swipe must travel before it dismisses, in logical pixels.
Sourcepub const fn timeout_value(&self) -> Duration
pub const fn timeout_value(&self) -> Duration
The auto-dismiss duration a queued toast inherits.
Sourcepub const fn limit_value(&self) -> usize
pub const fn limit_value(&self) -> usize
How many toasts stay unlimited.
Sourcepub const fn swipe_direction_value(&self) -> ToastSwipeDirection
pub const fn swipe_direction_value(&self) -> ToastSwipeDirection
The direction a swipe dismisses a toast.
Sourcepub const fn swipe_threshold_value(&self) -> f32
pub const fn swipe_threshold_value(&self) -> f32
How far a swipe must travel before it dismisses.
Sourcepub const fn is_expanded(&self) -> bool
pub const fn is_expanded(&self) -> bool
Whether the viewport is showing its stack expanded, Base UI’s expanded state.
Sourcepub fn set_expanded(&mut self, expanded: bool) -> bool
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.
pub fn entries(&self) -> &[ToastEntry]
pub fn len(&self) -> usize
pub fn is_empty(&self) -> bool
pub fn entry(&self, id: ToastId) -> Option<&ToastEntry>
Sourcepub fn push(&mut self, toast: Toast, now: Instant) -> ToastId
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.
Sourcepub fn add(&mut self, toast: Toast, now: Instant) -> ToastId
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.
Sourcepub fn update(&mut self, id: ToastId, toast: Toast, now: Instant) -> bool
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.
Sourcepub fn close(&mut self, id: ToastId) -> bool
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.
Sourcepub fn close_all(&mut self) -> bool
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.
Sourcepub fn promise(&mut self, loading: impl Into<Arc<str>>, now: Instant) -> ToastId
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.
Sourcepub fn resolve(&mut self, id: ToastId, resolved: Toast, now: Instant) -> bool
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.
Sourcepub fn dismiss(&mut self, id: ToastId) -> bool
pub fn dismiss(&mut self, id: ToastId) -> bool
Remove one toast, returning whether it was queued.
Sourcepub fn pause(&mut self, id: ToastId, now: Instant) -> bool
pub fn pause(&mut self, id: ToastId, now: Instant) -> bool
Pause one toast’s countdown on hover or focus, returning whether it changed.
Sourcepub fn resume(&mut self, id: ToastId, now: Instant) -> bool
pub fn resume(&mut self, id: ToastId, now: Instant) -> bool
Resume one paused toast’s countdown, returning whether it changed.
Sourcepub fn next_deadline(&self) -> Option<Instant>
pub fn next_deadline(&self) -> Option<Instant>
The single next auto-dismiss instant across the queue.
Sourcepub fn expire(&mut self, now: Instant) -> bool
pub fn expire(&mut self, now: Instant) -> bool
Remove every toast whose exact deadline has passed, returning whether the queue changed.
Sourcepub fn apply_swipe(
&mut self,
id: ToastId,
event: &PointerEvent,
) -> ToastSwipeChange
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
impl Clone for ToastManager
Source§fn clone(&self) -> ToastManager
fn clone(&self) -> ToastManager
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ToastManager
impl Debug for ToastManager
Source§impl Default for ToastManager
impl Default for ToastManager
Source§impl PartialEq for ToastManager
impl PartialEq for ToastManager
impl StructuralPartialEq for ToastManager
Auto Trait Implementations§
impl Freeze for ToastManager
impl RefUnwindSafe for ToastManager
impl Send for ToastManager
impl Sync for ToastManager
impl Unpin for ToastManager
impl UnsafeUnpin for ToastManager
impl UnwindSafe for ToastManager
Blanket Implementations§
impl<T> Action for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.