Struct Toast

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

Owned data for one overlay notification.

IDs route dismissal and should be unique. Duplicate IDs are accepted; a bound-host dismissal removes every matching value while invoking its callback once. Some("") description still selects the taller 72-pixel layout.

§Examples

use ailloli_ui_widgets::controls::{Toast, ToastTone};
let toast = Toast::new("saved", "Saved").tone(ToastTone::Success);
assert_eq!(toast.id(), "saved");

Implementations§

Source§

impl Toast

Source

pub fn new(id: impl Into<String>, title: impl Into<String>) -> Self

Creates a neutral, closable toast with no description or icon.

Empty and duplicate IDs are accepted but unique stable IDs are recommended.

§Examples
use ailloli_ui_widgets::controls::Toast;
let toast = Toast::new("connected", "Connected");
assert_eq!(toast.title(), "Connected");
Source

pub fn id(&self) -> &str

Borrows the exact dismissal identity.

§Examples
use ailloli_ui_widgets::controls::Toast;
let toast = Toast::new("job-1", "Started");
assert_eq!(toast.id(), "job-1");
Source

pub fn title(&self) -> &str

Borrows the exact primary title.

§Examples
use ailloli_ui_widgets::controls::Toast;
let toast = Toast::new("job-1", "Started");
assert_eq!(toast.title(), "Started");
Source

pub fn description(self, description: impl Into<String>) -> Self

Sets the secondary line, replacing any previous description.

An empty string remains Some and selects the taller toast layout.

§Examples
use ailloli_ui_widgets::controls::Toast;
let toast = Toast::new("saved", "Saved").description("All changes are on disk");
let _ = toast;
Source

pub fn tone(self, tone: ToastTone) -> Self

Sets the semantic accent tone.

§Examples
use ailloli_ui_widgets::controls::{Toast, ToastTone};
let toast = Toast::new("failed", "Failed").tone(ToastTone::Danger);
let _ = toast;
Source

pub fn leading_icon(self, icon: IconId) -> Self

Sets a tone-tinted leading icon, replacing any prior icon.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::controls::Toast;
let toast = Toast::new("done", "Done").leading_icon(IconId::Check);
let _ = toast;
Source

pub fn closable(self, closable: bool) -> Self

Controls whether the close icon, hit bound, and dismiss path are present.

Non-closable toasts can still be removed by changing the host’s source.

§Examples
use ailloli_ui_widgets::controls::Toast;
let toast = Toast::new("sync", "Syncing").closable(false);
let _ = toast;

Trait Implementations§

Source§

impl Clone for Toast

Source§

fn clone(&self) -> Toast

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Toast

Source§

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

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

impl PartialEq for Toast

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Toast

Auto Trait Implementations§

§

impl Freeze for Toast

§

impl RefUnwindSafe for Toast

§

impl Send for Toast

§

impl Sync for Toast

§

impl Unpin for Toast

§

impl UnwindSafe for Toast

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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.

§

impl<A> IntoClickAction<A> for A
where A: Clone + 'static,

§

fn into_click_action(self) -> ClickAction<A>

Implements the into_click_action helper used by this module.

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

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