Struct LoadingAnimation

pub struct LoadingAnimation<T: Send + Sync + 'static> { /* private fields */ }

Loading animation view that runs a task in a background thread and shows a loading animation and message while it completes and allows for retrieval of a return value. It is recommended to use load_resource() instead of this directly since it has a simpler interface

Example

let mut root = cursive::default();
let anim = LoadingAnimation::new("Loading Dummy Resource...", || {
    thread::sleep(Duration::from_secs(10));
});
 
root.add_layer(Dialog::around(anim.with_name("loader")).title("Loading..."));
root.set_fps(30);

root.set_global_callback(Event::Refresh, |root| {
    let mut loader = root.find_name::<LoadingAnimation<()>>("loader").unwrap();
    if loader.is_done() {
        loader.finish().unwrap_or(());
        root.quit()
    }
});
root.run();

Implementations

impl<T: Send + Sync> LoadingAnimation<T>

pub fn new<U, M: Into<StyledString>>(message: M, task: U) -> LoadingAnimation<T>

where U: FnOnce() -> T + Send + Sync + 'static,

Create a new LoadingAnimation with the specified closure or function pointer as the task

pub fn is_done(&self) -> bool

Has the background task finished executing?

pub fn finish(&mut self) -> Option<T>

Join with the task’s thread, block until it is finished, and return the resulting value

It is best to run this when LoadingAnimation::is_done() is true

This will return None if called more than once

Panics

This method will panic if the underlying task panicked while executing

Trait Implementations

impl<T: Clone + Send + Sync + 'static> Clone for LoadingAnimation<T>

fn clone(&self) -> LoadingAnimation<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Send + Sync> View for LoadingAnimation<T>

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

fn layout(&mut self, _: Vec2)

Called once the size for this view has been decided.

fn required_size(&mut self, _: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions.

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn on_event(&mut self, _: Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn call_on_any( &mut self, _: &Selector<'_>, _: &mut dyn FnMut(&mut (dyn View + 'static)), )

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, _: &Selector<'_>) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector.

fn take_focus(&mut self, source: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

fn important_area(&self, view_size: XY<usize>) -> Rect

What part of the view is important and should be visible?

fn type_name(&self) -> &'static str

Returns the type of this view.