Struct CancellableLoader 

pub struct CancellableLoader { /* private fields */ }

A Loader that can be cancelled via Ctrl-C.

The cancellation signal is an AtomicBool behind an Arc, so it can be shared across threads or tasks. The loader itself does not stop rendering when cancelled; the application should check is_cancelled and take action.

Implementations

impl CancellableLoader

pub fn new( message: impl Into<String>, spinner_color: Option<String>, message_color: Option<String>, ) -> Self

Create a new cancellable loader with the given message.

pub fn cancel(&self)

Set the cancellation flag.

pub fn is_cancelled(&self) -> bool

Returns true if cancellation has been requested.

pub fn tick(&mut self)

Advance the underlying spinner frame.

Trait Implementations

impl Component for CancellableLoader

fn render(&self, width: u16) -> Result<Rendered, RenderError>

Render this component into lines of text at the given width.

fn handle_input(&mut self, event: &Event) -> InputResult

Handle an input event (key press, resize, mouse, etc.).

fn render_rect(&self, rect: Rect) -> Result<Rendered, RenderError>

Render this component into a specific rectangular area.

fn wants_key_release(&self) -> bool

Returns true if this component wants to receive KeyEventKind::Release events in addition to Press / Repeat.

fn as_focusable(&self) -> Option<&dyn Focusable>

Cast this component to a Focusable reference, if supported.

fn as_focusable_mut(&mut self) -> Option<&mut dyn Focusable>

Cast this component to a mutable Focusable reference, if supported.