Skip to main content

ToastStore

Struct ToastStore 

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

Entity holding the active toasts — v3’s ToastQueue.

Implementations§

Source§

impl ToastStore

Source

pub fn subscribe( store: &Entity<Self>, cx: &mut App, f: impl FnMut(&mut App) + 'static, ) -> Subscription

ToastQueue.subscribe — run f whenever the queue changes.

v3 returns an unsubscribe function; gpui returns a Subscription whose drop does the same, so the caller keeps it for as long as it wants the callback.

Source

pub fn toasts(&self) -> &[ToastData]

The active toasts, newest first.

Source

pub fn visible_toasts(&self, max_visible: usize) -> &[ToastData]

The newest toasts currently exposed by maxVisibleToasts; overflow remains queued until a visible toast closes.

Source

pub fn pause_all(&mut self)

pauseAll — stop every toast’s dismissal clock.

Source

pub fn resume_all(&mut self)

resumeAll — start them again.

Source

pub fn is_paused(&self) -> bool

Whether all timers were paused explicitly (pauseAll).

Source

pub fn timers_paused(&self) -> bool

True while the region is hovered or focus-within, or pauseAll is on.

Source

pub fn is_interaction_paused(&self) -> bool

Whether timers are paused by hover or focus within the region.

Source

pub fn exiting(&self) -> &[ToastData]

Cards still mounted after close for exitDuration.

Source

pub fn is_expanded(&self) -> bool

The last data-expanded the viewport painted.

Source

pub fn hidden_toasts(&self, max_visible: usize) -> &[ToastData]

Overflow past maxVisibleToasts — still queued, marked data-hidden.

Source

pub fn add(store: &Entity<Self>, data: ToastData, cx: &mut App) -> u64

add — queue a toast, notify subscribers, and return its id.

Source

pub fn close(store: &Entity<Self>, id: u64, cx: &mut App)

close — drop one toast by id and report its onClose once.

The card leaves Self::toasts immediately. Unless reduced motion is on or exitDuration is zero, it stays in Self::exiting for the configured fade so [data-exiting] can paint. onClose still fires at the start of that exit, matching the pinned queue.

Source

pub fn clear(store: &Entity<Self>, cx: &mut App)

clear — drop all of them and notify subscribers.

Source

pub fn insert(&mut self, data: ToastData) -> u64

Inserts a fully-formed toast; zero ids are auto-assigned.

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<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> ErasedDestructor for T
where T: 'static,

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

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