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!").set_duration(Duration::from_secs(5)).set_closable(true);
// More app code
t.show(ctx);

Implementations§

Source§

impl Toasts

Source

pub const fn new() -> Toasts

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 const fn reverse(self, reverse: bool) -> Toasts

Should toasts be added in reverse order?

Source

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

Where toasts should appear.

Source

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

Sets spacing between adjacent toasts.

Source

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

Margin or distance from screen to toasts’ bounding boxes

Source

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

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

Source§

impl Toasts

Source

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

Displays toast queue

Trait Implementations§

Source§

impl Default for Toasts

Source§

fn default() -> Toasts

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

Auto Trait Implementations§

§

impl Freeze for Toasts

§

impl RefUnwindSafe for Toasts

§

impl Send for Toasts

§

impl Sync for Toasts

§

impl Unpin for Toasts

§

impl UnwindSafe for Toasts

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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

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> FromWorld for T
where T: Default,

Source§

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

Creates Self using data from the given World
Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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, 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> 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
Source§

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

Source§

impl<T> Event for T
where T: Send + Sync + 'static,