Struct Toast 

pub struct Toast { /* private fields */ }

Toast — a present-able request (NOT a Widget). Construct with one of the severity-named constructors, configure via builder methods, then call .present(ctx) or ctx.show_toast(self). Internally the builder is consumed and its data is moved into a slot on the installed ToastHost.

See the module docs for the full conceptual overview.

Implementations

impl Toast

pub fn info(title: impl Into<LocalizedString>) -> Self

Info-severity toast (status confirmation, neutral notice).

pub fn success(title: impl Into<LocalizedString>) -> Self

Success-severity toast (“Saved”, “Connected”, “Build finished”).

pub fn warning(title: impl Into<LocalizedString>) -> Self

Warning-severity toast.

pub fn error(title: impl Into<LocalizedString>) -> Self

Error-severity toast. Defaults to Live::Assertive.

pub fn loading(title: impl Into<LocalizedString>) -> Self

Loading-style toast — Info severity with a Spinner as the leading widget. Persistent by default; the app calls ToastHandle::dismiss (typically from the operation’s completion callback) or replaces it with a success/error toast.

pub fn body(self, text: impl Into<LocalizedString>) -> Self

Optional secondary line below the title.

pub fn leading(self, widget: impl Widget + 'static) -> Self

Replace the default severity glyph with a custom leading widget (spinner, app icon, avatar). Boxes the widget so the toast remains object-safe.

pub fn action(self, action: ToastAction) -> Self

Append a ToastAction (link or button) to the toast.

pub fn primary_action( self, label: impl Into<LocalizedString>, on_invoke: impl Fn(&mut EventContext<'_>) + 'static, ) -> Self

Shorthand for appending a filled-button primary action — equivalent to .action(ToastAction::primary(label, on_invoke)).

pub fn auto_dismiss_after(self, duration: Duration) -> Self

Override the auto-dismiss countdown. Pass Duration::ZERO for immediate dismissal on the next timer tick; call persistent to disable the timer entirely.

pub fn persistent(self) -> Self

Disable auto-dismiss — the toast persists until the user clicks the close X, invokes a closes_toast action, or the app calls ToastHandle::dismiss.

pub fn priority(self, priority: ToastPriority) -> Self

Set the queue priority. High / Urgent entries evict the oldest Normal entry when the slot pool is full; Urgent also forces Live::Assertive regardless of severity.

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

Stable identity for the “progress toast updates in place” pattern. A subsequent enqueue whose Toast carries the same id as a still-live entry mutates that entry’s fields (severity, title/body, route, …) in place instead of appending a new toast — see ToastRegistry::enqueue’s update-in-place merge for the exact behaviour.

Hazard: this id must be unique per logical operation, not just per call site

The merge matches on id ALONE — no route/window/audience check — and then OVERWRITES the existing entry’s route with the new toast’s resolved target. That’s intentional: it’s what lets a progress toast whose audience becomes known partway through retarget itself in place. But it also means that if TWO DIFFERENT windows (or two different audiences) each present a toast using the SAME id for what are, to the app, two DIFFERENT operations, the second enqueue finds the first window’s still-live entry, mutates its text/severity to the second operation’s, and steals its route out from under it — the first window’s toast is not dismissed, not callback’d, just silently overwritten and gone, while the second window’s operation ends up displayed under the wrong route besides.

teksilo deliberately does NOT make the dedup key route-aware (matching on (id, route) together) — that would break the intentional retargeting case above. So in a multi-window / multi-document app, do not reuse one static string id across windows for what is conceptually a per-document (or otherwise per-audience) operation — export, delete, save, etc. Fold the document/audience identity into the id yourself, e.g. format!("export-{work_id}") rather than a bare "export" constant, so two windows running the same kind of operation on two different documents never collide on one entry.

pub fn on_click(self, f: impl Fn(&mut EventContext<'_>) + 'static) -> Self

Treat a click on the toast body as a meaningful action — the callback fires on tap. Cursor changes to Pointer over the body.

pub fn on_dismiss( self, f: impl Fn(ToastDismissCause, &mut EventContext<'_>) + 'static, ) -> Self

Notification of dismissal. Fires exactly once per toast on any dismiss path (timer, action invocation, close click, escape, programmatic, host shutdown, slot-pool overflow).

pub fn show_close_button(self, show: bool) -> Self

Show or hide the trailing close (×) button. Default true.

pub fn closable_on_escape(self, allow: bool) -> Self

Whether pressing Escape while the toast is focused dismisses it. Default true. Set to false in apps that have a custom Escape-handling story (focus trap, modal-style toast).

pub fn announcement(self, text: impl Into<LocalizedString>) -> Self

Override the screen-reader announcement text without changing the visible title. Useful when the visible title is iconic (“3”) but the spoken text needs context (“3 unread messages”).

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

Whether this toast is added to the persistent archive that drives NotificationLog. Default true. Set false for noise-suppressing transient notifications like quick “Copied!” feedback.

pub fn style(self, style: impl ToastStyle) -> Self

Override the visual chrome for this toast instance. Takes precedence over the theme-wide style_slots.toast slot and the built-in RecipeToastStyle default.

pub fn target(self, audience: ToastAudience) -> Self

Route this toast to every window currently assigned audience (via ToastRegistry::set_window_audience), instead of the default origin-window. Overrides any previous .target() / .broadcast() call — last setter wins.

pub fn broadcast(self) -> Self

Route this toast to every window, unconditionally — for genuinely app-wide messages (a data-loss warning, an update available notice) rather than one window’s concern. Overrides any previous .target() call — last setter wins.

pub fn present(self, ctx: &mut EventContext<'_>) -> ToastHandle

Submit the toast through the installed ToastHost. Equivalent to ctx.show_toast(self). Returns a ToastHandle for programmatic control. If install_toast was not called the returned handle is in the “dropped” state (is_alive returns false) and a one-shot stderr warning fires explaining the omission.

Trait Implementations

impl Debug for Toast

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

Formats the value using the given formatter.