Struct progressing::ClampingBar

pub struct ClampingBar { /* fields omitted */ }

A progressbar clamping values to [0, 1].

Mini-Example

use progressing::Bar;

/// Printing value 0.3 clamped to [0, 1]
/// [=====>------------]
fn main() -> Result<(), String> {
    println!("Printing value 0.3 clamped to [0, 1]");
    let mut progressbar = progressing::ClampingBar::new();
    progressbar.set_bar_len(20);
    progressbar.set(0.3).reprintln()
}

It is only optimized for single-length-strings, but strings are more handy than chars and hence used as implementation.

Methods

impl ClampingBar

pub fn new() -> ClampingBar

pub fn from(bar_len: usize, prefix: String) -> ClampingBar

Trait Implementations

impl Bar for ClampingBar

type Progress = f32

fn bar_len(&self) -> usize

fn set_bar_len(&mut self, new_bar_len: usize)

panics if length is < 3

fn progress(&self) -> f32

fn set<P: Into<f32>>(&mut self, new_progress: P) -> &mut Self

Sets the progress to the given value

fn add<P: Into<f32>>(&mut self, delta: P) -> &mut Self

Adds the given progress to the current progress

fn display(&self) -> String

Returns the printable progressbar.

fn write_to_stdout<S: Into<String>>(&self, msg: S) -> Result<(), String>

fn print(&self) -> Result<(), String>

Prints a progressbar using given progress. Does not print a newline-character. Use println(...) for printing a newline-character. Use reprint(...) for overwriting the current stdout-line.

fn println(&self) -> Result<(), String>

Prints a progressbar using given progress. In additon to print(...), this function prints a new line. Use reprintln(...) for overwriting the current stdout-line.

fn reprint(&self) -> Result<(), String>

Prints the current line again with progressbar using given progress. Does not print a newline-character. Use reprintln(...) for reprinting with a newline-character.

fn reprintln(&self) -> Result<(), String>

Prints the current line again with progressbar using given progress. In additon to reprint(...), this function prints a new line. Use println(...) for always printing a newline-character.

impl Debug for ClampingBar

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for ClampingBar

fn default() -> Self

Returns the "default value" for a type.

impl Display for ClampingBar

fn fmt(&self, f: &mut Formatter) -> Result

Progress is clamped to [0, 1].