Skip to main content

Toasts

Struct Toasts 

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

Main notifications collector.

§Usage

You need to create Toasts once and call .show(ctx) in every frame.

use egui_notify::Toasts;

let mut t = Toasts::default();
t.info("Hello, World!").duration(Some(Duration::from_secs(5))).closable(true);
// More app code
t.show(ctx);

Implementations§

Source§

impl Toasts

Source

pub const fn new() -> Self

Creates new Toasts instance.

Source

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

Adds new toast to the collection. By default adds toast at the end of the list, can be changed with self.reverse.

Source

pub fn dismiss_oldest_toast(&mut self)

Dismisses the oldest toast

Source

pub fn dismiss_latest_toast(&mut self)

Dismisses the most recent toast

Source

pub fn dismiss_all_toasts(&mut self)

Dismisses all toasts

Source

pub fn success(&mut self, caption: impl Into<String>) -> &mut Toast

Shortcut for adding a toast with info success.

Source

pub fn info(&mut self, caption: impl Into<String>) -> &mut Toast

Shortcut for adding a toast with info level.

Source

pub fn warning(&mut self, caption: impl Into<String>) -> &mut Toast

Shortcut for adding a toast with warning level.

Source

pub fn error(&mut self, caption: impl Into<String>) -> &mut Toast

Shortcut for adding a toast with error level.

Source

pub fn basic(&mut self, caption: impl Into<String>) -> &mut Toast

Shortcut for adding a toast with no level.

Source

pub fn custom( &mut self, caption: impl Into<String>, level_string: String, level_color: Color32, ) -> &mut Toast

Shortcut for adding a toast with custom level.

Source

pub const fn reverse(self, reverse: bool) -> Self

Should toasts be added in reverse order?

Source

pub const fn with_anchor(self, anchor: Anchor) -> Self

Where toasts should appear.

Source

pub const fn with_spacing(self, spacing: f32) -> Self

Sets spacing between adjacent toasts.

Source

pub const fn with_margin(self, margin: Vec2) -> Self

Margin or distance from screen to toasts’ bounding boxes

Source

pub const fn with_shadow(self, shadow: Shadow) -> Self

Enables the use of a shadow for toasts.

Source

pub const fn with_padding(self, padding: Vec2) -> Self

Padding or distance from toasts’ bounding boxes to inner contents.

Source

pub fn with_default_font(self, font: FontId) -> Self

Changes the default font used for all toasts.

Source§

impl Toasts

Source

pub fn show(&mut self, ctx: &Context)

Displays toast queue

Trait Implementations§

Source§

impl Default for Toasts

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> ConditionalSend for T
where T: Send,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &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)

Converts &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> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<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> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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