Skip to main content

Toast

Struct Toast 

Source
pub struct Toast<Message>
where 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

Bold heading line — typically a few words.

§message: String

Body text — one or two short sentences, explaining the situation.

§intent: ToastIntent

Semantic category (Info, Success, Warning, …). Resolved to a theme color by the engine.

§lifetime: ToastLifetime

Auto-dismiss policy. Defaults to ToastLifetime::DEFAULT (4-second transient).

§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> Toast<Message>
where Message: Clone,

Source

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

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.

§Example
use snora_core::{Toast, ToastIntent};

#[derive(Clone, Debug)]
enum Msg { DismissToast(u64) }

let toast = Toast::new(
    /* id */       1,
    /* intent */   ToastIntent::Success,
    /* title */    "Saved",
    /* message */  "Your changes are stored.",
    /* on_dismiss */ Msg::DismissToast(1),
);
assert_eq!(toast.id, 1);
assert_eq!(toast.title, "Saved");
assert_eq!(toast.intent, ToastIntent::Success);
Source

pub fn with_lifetime(self, lifetime: ToastLifetime) -> Toast<Message>

Override the lifetime.

Source

pub fn persistent(self) -> Toast<Message>

Make this toast persistent (never auto-dismiss).

Use for notifications the user must explicitly acknowledge — “Export complete”, “Disk almost full”, confirmations of long operations.

§Example
use snora_core::{Toast, ToastIntent, ToastLifetime};

#[derive(Clone, Debug)]
enum Msg { DismissToast(u64) }

let toast = Toast::new(
    1, ToastIntent::Info, "Exported", "Done.", Msg::DismissToast(1),
)
.persistent();
assert_eq!(toast.lifetime, ToastLifetime::Persistent);
Source

pub fn with_created_at(self, created_at: Instant) -> Toast<Message>

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 for Toast<Message>
where Message: Clone,

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

Source§

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

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<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<State, Message> IntoBoot<State, Message> for State

Source§

fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some Application.
Source§

impl<T> MaybeClone for T

Source§

impl<T> MaybeDebug for T

Source§

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

Source§

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

Source§

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

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.
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