Struct cursive_async_view::AsyncProgressView
source · [−]pub struct AsyncProgressView<T: View> { /* private fields */ }
Expand description
An AsyncProgressView
is a wrapper view that displays a progress bar, until the
child view is successfully created or an error in the creation progress occured.
To achieve this a poll_ready
callback is passed in the creation of AsyncProgressView
which
returns an AsyncProgressState
that can indicate that the process is still Pending
(this contains a float
between 0 and 1, communicating the progress, this information is displayed in the bar), has been successfully
completed Available
containing the view to be displayed, or if the creation has thrown an Error
containing a message to be shown to the user.
The poll_ready
callback should only check for data to be
available and create the child view when the data got available. It must
never block until the data is available or do heavy calculations!
Otherwise cursive cannot proceed displaying and your
application will have a blocking loading process!
If you have troubles and need some more in-depth examples have a look at the provided examples
in the project.
Example usage
use cursive::{views::TextView, Cursive, CursiveExt};
use cursive_async_view::{AsyncProgressView, AsyncProgressState};
let mut siv = Cursive::default();
let start = std::time::Instant::now();
let async_view = AsyncProgressView::new(&mut siv, move || {
if start.elapsed().as_secs() < 3 {
AsyncProgressState::Pending(start.elapsed().as_secs() as f32 / 3f32)
} else {
AsyncProgressState::Available(TextView::new("Finally it loaded!"))
}
});
siv.add_layer(async_view);
// siv.run();
Implementations
pub fn new<F>(siv: &mut Cursive, creator: F) -> Self where
F: FnMut() -> AsyncProgressState<T> + 'static,
pub fn new<F>(siv: &mut Cursive, creator: F) -> Self where
F: FnMut() -> AsyncProgressState<T> + 'static,
Create a new AsyncProgressView
instance. The cursive reference is only used to
update the screen when a progress update is received. In order to show the view,
it has to be directly or indirectly added to a cursive layer like any other view.
The creator function will be executed on a dedicated thread in the background. Make sure that this function will never block indefinitely. Otherwise, the creation thread will get stuck.
Mark the maximum allowed width in characters, the progress bar may consume. By default, the width will be inherited by the parent view.
Mark the maximum allowed height in characters, the progress bar may consume. By default, the height will be inherited by the parent view.
pub fn with_progress_fn<F>(self, progress_fn: F) -> Self where
F: Fn(usize, usize, f32, usize, usize) -> AnimationProgressFrame + 'static,
pub fn with_progress_fn<F>(self, progress_fn: F) -> Self where
F: Fn(usize, usize, f32, usize, usize) -> AnimationProgressFrame + 'static,
Set a custom progress function for this view, indicating the progress of the
wrapped view creation. See the default_progress
function reference for an
example on how to create a custom progress function.
pub fn with_error_fn<F>(self, error_fn: F) -> Self where
F: Fn(String, usize, usize, f32, usize, usize) -> AnimationProgressFrame + 'static,
Set the maximum allowed width in characters, the progress bar may consume.
Set the maximum allowed height in characters, the progress bar may consume.
pub fn set_progress_fn<F>(&mut self, progress_fn: F) where
F: Fn(usize, usize, f32, usize, usize) -> AnimationProgressFrame + 'static,
pub fn set_progress_fn<F>(&mut self, progress_fn: F) where
F: Fn(usize, usize, f32, usize, usize) -> AnimationProgressFrame + 'static,
Set a custom progress function for this view, indicating the progress of the
wrapped view creation. See the default_progress
function reference for an
example on how to create a custom progress function.
The function may be set at any time. The progress bar can be changed even if the previous progress bar has already be drawn.
pub fn set_error_fn<F>(&mut self, error_fn: F) where
F: Fn(String, usize, usize, f32, usize, usize) -> AnimationProgressFrame + 'static,
pub fn set_error_fn<F>(&mut self, error_fn: F) where
F: Fn(String, usize, usize, f32, usize, usize) -> AnimationProgressFrame + 'static,
Set a custom error function for this view, indicating that an error occured during the
wrapped view creation. See the default_progress_error
function reference for an
example on how to create a custom error function.
The function may be set at any time. The progress bar can be changed even if the previous progress bar has already be drawn.
Make the progress bar inherit its width from the parent view. This is the default.
Make the progress bar inherit its height from the parent view. This is the default.
Trait Implementations
Draws the view with the given printer (includes bounds) and focus. Read more
Should return true
if the view content changed since the last call
to layout()
. Read more
Returns the minimum size the view requires with the given restrictions. Read more
Called when an event is received (key press, mouse event, …). Read more
Runs a closure on the view identified by the given selector. Read more
Moves the focus to the view identified by the given selector. Read more
Attempt to give this view the focus. Read more
What part of the view is important and should be visible? Read more
Auto Trait Implementations
impl<T> !RefUnwindSafe for AsyncProgressView<T>
impl<T> !Send for AsyncProgressView<T>
impl<T> !Sync for AsyncProgressView<T>
impl<T> Unpin for AsyncProgressView<T> where
T: Unpin,
impl<T> !UnwindSafe for AsyncProgressView<T>
Blanket Implementations
Mutably borrows from an owned value. Read more
Returns a Box<View>
.
Wraps self
in a ResizedView
with the given size constraints.
Wraps self
into a fixed-size ResizedView
.
Wraps self
into a fixed-width ResizedView
.
Wraps self
into a fixed-width ResizedView
.
Wraps self
into a full-screen ResizedView
.
Wraps self
into a full-width ResizedView
.
Wraps self
into a full-height ResizedView
.
Wraps self
into a limited-size ResizedView
.
Wraps self
into a limited-width ResizedView
.
Wraps self
into a limited-height ResizedView
.
Wraps self
into a ResizedView
at least sized size
.
Wraps self
in a ResizedView
at least min_width
wide.
Wraps self
in a ResizedView
at least min_height
tall.
Wraps self
in a ScrollView
.
Calls the given closure and return the result. Read more
Calls the given closure on self
.