Struct ToastEngine 

pub struct ToastEngine<A>
where
    A: From<ToastMessage> + Send + 'static,
{ /* private fields */ }

A toast engine for displaying temporary messages in a terminal UI. The ToastEngine manages the display of toasts, which are temporary messages that appear on the screen for a short duration. It supports different types of toasts (info, success, warning, error) and allows customization of their position and duration. You can call show_toast to display a toast, and hide_toast to hide the toast. To animate, you can get the area of the toast using toast_area and implement your animation logic based on that area. #[derive(Debug)] Caveat: If you’re not using the tokio feature, create a ToastEngine<()>. There is a (hacky) impl to make it work without the tokio feature.

Implementations

impl<A> ToastEngine<A>

where A: From<ToastMessage> + Send + 'static,

pub fn new(_: Self) -> Self

Creates a new ToastEngine. Consider using the ToastEngineBuilder instead.

pub fn from_builder(_: ToastEngineBuilder<A>) -> Self

Creates a new ToastEngine from a ToastEngineBuilder. This method takes the configuration from the builder and initializes the ToastEngine accordingly. It sets up the area for displaying toasts, the default duration for toasts, and any channel sender if provided (when using the tokio feature).

pub fn show_toast(&mut self, toast: ToastBuilder)

Shows a toast message using the provided ToastBuilder. This method calculates the area for the toast based on the message content and the specified position, creates a new Toast instance, and sets it as the current toast to be rendered. If the tokio feature is enabled and a channel sender is configured, it also spawns a task to automatically hide the toast after the default duration.

pub fn toast_area(&self) -> Rect

Get the area where the toast will be rendered.

pub fn has_toast(&self) -> bool

Whether a toast is currently being displayed.

pub fn hide_toast(&mut self)

Hides the currently displayed toast, if any. This method sets the current toast to None, which will cause it to no longer be rendered on the screen.

pub fn set_area(&mut self, area: Rect)

Sets the area for the toast engine. This method allows you to update the area where toasts will be displayed, which can be useful if the layout of your terminal UI changes and you need to adjust the toast display area accordingly.

Trait Implementations

impl<A> Widget for &ToastEngine<A>

where A: From<ToastMessage> + Send + 'static,

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

impl<A> WidgetRef for ToastEngine<A>

where A: From<ToastMessage> + Send + 'static,

fn render_ref(&self, _area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.