Struct State 

pub struct State<A = ()> { /* private fields */ }

Available on crate feature toast only.

The toast queue. The first limit toasts are visible and counting down; the rest wait until a visible one closes.

A toast with an action goes ahead of every toast without one that is waiting, and when the visible toasts are full it takes the place of the newest visible toast without an action, which waits again and restarts its countdown when it comes back. While the pointer is over the toasts (Event::Pause) no countdown runs.

A is what action buttons hand back, usually the app’s message, so an Undo toast can carry the message that undoes. A queue without payloads is State<()>, made with State::new; one with payloads is made with State::default.

Implementations

impl State

pub fn new() -> Self

impl<A> State<A>

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

Sets how many toasts are visible at once. At least one is.

pub fn limit(&self) -> usize

pub fn push(&mut self, toast: Toast) -> Id

Queues a toast and returns its id.

pub fn push_with(&mut self, toast: Toast, payload: A) -> Id

Queues a toast whose action button hands back payload as Output::Payload, and returns its id.

pub fn dismiss(&mut self, id: Id) -> Option<Toast>

Removes a toast, visible or waiting, dropping any payload.

pub fn tick(&mut self, now: Instant) -> Vec<Id>

Closes expired toasts and starts the countdown of newly visible ones. While paused, the time since the last tick is added back to every countdown instead. Returns the ids that closed.

pub fn is_paused(&self) -> bool

Whether the countdowns are stopped because the pointer is over the toasts.

pub fn update(&mut self, event: Event) -> Option<Output<A>>

pub fn visible(&self) -> impl Iterator<Item = (Id, &Toast)>

The visible toasts, top to bottom in queue order: oldest first, with toasts that have an action moved ahead of waiting ones.

pub fn waiting(&self) -> usize

How many toasts are waiting behind the visible ones.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn needs_tick(&self) -> bool

Whether a visible toast still has to count down.

pub fn ids(&self) -> impl Iterator<Item = Id>

Every queued toast id, visible first, in queue order.

Trait Implementations

impl<A: Clone> Clone for State<A>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for State<A>

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

Formats the value using the given formatter.

impl<A> Default for State<A>

fn default() -> Self

Returns the “default value” for a type.