[−][src]Struct cursive::views::ProgressBar
Animated bar showing a progress value.
This bar has an internal counter, and adapts the length of the displayed bar to the relative position of the counter between a minimum and maximum values.
It also prints a customizable text in the center of the bar, which defaults to the progression percentage.
The bar defaults to the current theme's highlight color, but that can be customized.
Example
let bar = ProgressBar::new() .with_task(|counter| { // This closure is called in parallel. for _ in 0..100 { // Here we can communicate some // advancement back to the bar. counter.tick(1); } });
Methods
impl ProgressBar
[src]
pub fn new() -> Self
[src]
Creates a new progress bar.
Default values:
min
: 0max
: 100value
: 0
pub fn with_value(self, value: Counter) -> Self
[src]
Sets the value to follow.
Use this to manually control the progress to display
by directly modifying the value pointed to by value
.
pub fn start<F: FnOnce(Counter) + Send + 'static>(&mut self, f: F)
[src]
Starts a function in a separate thread, and monitor the progress.
f
will be given a Counter
to increment the bar's progress.
This does not reset the value, so it can be called several times to advance the progress in multiple sessions.
pub fn with_task<F: FnOnce(Counter) + Send + 'static>(self, task: F) -> Self
[src]
Starts a function in a separate thread, and monitor the progress.
Chainable variant.
pub fn with_label<F: Fn(usize, (usize, usize)) -> String + 'static>(
self,
label_maker: F
) -> Self
[src]
self,
label_maker: F
) -> Self
Sets the label generator.
The given function will be called with (value, (min, max))
.
Its output will be used as the label to print inside the progress bar.
The default one shows a percentage progress:
fn make_progress(value: usize, (min, max): (usize, usize)) -> String { let percent = 101 * (value - min) / (1 + max - min); format!("{} %", percent) }
pub fn min(self, min: usize) -> Self
[src]
Sets the minimum value.
When value
equals min
, the bar is at the minimum level.
If self.min > max
, self.min
is set to max
.
pub fn max(self, max: usize) -> Self
[src]
Sets the maximum value.
When value
equals max
, the bar is at the maximum level.
If min > self.max
, self.max
is set to min
.
pub fn range(self, min: usize, max: usize) -> Self
[src]
Sets the min
and max
range for the value.
If min > max
, swap the two values.
pub fn set_value(&mut self, value: usize)
[src]
Sets the current value.
Value is clamped between min
and max
.
pub fn set_color<C>(&mut self, color: C) where
C: Into<ColorType>,
[src]
C: Into<ColorType>,
Sets the color style.
The default color is PaletteColor::Highlight
.
pub fn with_color<C>(self, color: C) -> Self where
C: Into<ColorType>,
[src]
C: Into<ColorType>,
Sets the color style.
Chainable variant of set_color
.
Trait Implementations
impl View for ProgressBar
[src]
fn draw(&self, printer: &Printer)
[src]
fn layout(&mut self, _: Vec2)
[src]
Called once the size for this view has been decided. Read more
fn needs_relayout(&self) -> bool
[src]
Should return true
if the view content changed since the last call to layout()
. Read more
fn required_size(&mut self, constraint: Vec2) -> Vec2
[src]
Returns the minimum size the view requires with the given restrictions. Read more
fn on_event(&mut self, _: Event) -> EventResult
[src]
Called when an event is received (key press, mouse event, ...). Read more
fn call_on_any<'a>(&mut self, _: &Selector, _: AnyCb<'a>)
[src]
Runs a closure on the view identified by the given selector. Read more
fn focus_view(&mut self, _: &Selector) -> Result<(), ()>
[src]
Moves the focus to the view identified by the given selector. Read more
fn take_focus(&mut self, source: Direction) -> bool
[src]
This view is offered focus. Will it take it? Read more
fn important_area(&self, view_size: Vec2) -> Rect
[src]
What part of the view is important and should be visible? Read more
impl Default for ProgressBar
[src]
Auto Trait Implementations
impl !Send for ProgressBar
impl !Sync for ProgressBar
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From for T
[src]
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.