Skip to main content

Toast

Struct Toast 

Source
pub struct Toast<Message: Clone> {
    pub id: u64,
    pub title: String,
    pub message: String,
    pub intent: ToastIntent,
    pub lifetime: ToastLifetime,
    pub created_at: Instant,
    pub on_dismiss: Message,
}
Expand description

A toast notification.

Message is your application’s top-level message type. The on_dismiss field is fired when the user clicks the toast’s close button. It is not fired when a transient toast expires; expiration is a silent sweep.

Fields§

§id: u64

Application-assigned id. snora does not interpret or generate ids; the application is the source of truth. Typically a monotonically increasing u64.

§title: String§message: String§intent: ToastIntent§lifetime: ToastLifetime§created_at: Instant

When this toast was enqueued. Used with lifetime to compute expiration.

§on_dismiss: Message

Emitted when the user clicks the close button.

Implementations§

Source§

impl<Message: Clone> Toast<Message>

Source

pub fn new( id: u64, intent: ToastIntent, title: impl Into<String>, message: impl Into<String>, on_dismiss: Message, ) -> Self

Build a new toast with created_at set to Instant::now().

This constructor takes the mandatory fields positionally and uses ToastLifetime::DEFAULT for the lifetime. Use builder-style methods below to customize further.

Source

pub fn with_lifetime(self, lifetime: ToastLifetime) -> Self

Override the lifetime.

Source

pub fn persistent(self) -> Self

Make this toast persistent (never auto-dismiss).

Source

pub fn with_created_at(self, created_at: Instant) -> Self

Override the creation timestamp. Mainly useful for tests.

Source

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

True when this toast has outlived its transient deadline. Persistent toasts always return false.

Trait Implementations§

Source§

impl<Message: Clone + Clone> Clone for Toast<Message>

Source§

fn clone(&self) -> Toast<Message>

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<Message: Debug + Clone> Debug for Toast<Message>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Message> Freeze for Toast<Message>
where Message: Freeze,

§

impl<Message> RefUnwindSafe for Toast<Message>
where Message: RefUnwindSafe,

§

impl<Message> Send for Toast<Message>
where Message: Send,

§

impl<Message> Sync for Toast<Message>
where Message: Sync,

§

impl<Message> Unpin for Toast<Message>
where Message: Unpin,

§

impl<Message> UnsafeUnpin for Toast<Message>
where Message: UnsafeUnpin,

§

impl<Message> UnwindSafe for Toast<Message>
where Message: UnwindSafe,

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.