Struct progressing::MappingBar

pub struct MappingBar<N> { /* fields omitted */ }

A progressbar mapping values from [a, b] (e.g. [-9, 5]) to [0, 1].

use progressing::Bar;

/// Mapping from [-9, 5] to [0, 1]
/// [================>-] (4 / 5)
fn main() -> Result<(), String> {
    println!("Mapping from [-9, 5] to [0, 1]");
    let mut progressbar = progressing::MappingBar::new(-9..=5);
    progressbar.set_bar_len(20);
    progressbar.set(4).reprintln()
}

Methods

impl<N> MappingBar<N> where
    MappingBar<N>: Default, 

pub fn new(range: RangeInclusive<N>) -> MappingBar<N>

impl MappingBar<usize>

pub fn start(&self) -> usize

pub fn end(&self) -> usize

impl MappingBar<u32>

pub fn start(&self) -> u32

pub fn end(&self) -> u32

impl MappingBar<i32>

pub fn start(&self) -> i32

pub fn end(&self) -> i32

Trait Implementations

impl Bar for MappingBar<usize>

type Progress = usize

fn bar_len(&self) -> usize

fn set_bar_len(&mut self, new_bar_len: usize)

Do not shorten the length before reprinting since the line will be overwritten, not cleared.

fn progress(&self) -> usize

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

Sets the progress to the given value

fn add<P: Into<usize>>(&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 Bar for MappingBar<u32>

type Progress = u32

fn bar_len(&self) -> usize

fn set_bar_len(&mut self, new_bar_len: usize)

Do not shorten the length before reprinting since the line will be overwritten, not cleared.

fn progress(&self) -> u32

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

Sets the progress to the given value

fn add<P: Into<u32>>(&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 Bar for MappingBar<i32>

type Progress = i32

fn bar_len(&self) -> usize

fn set_bar_len(&mut self, new_bar_len: usize)

Do not shorten the length before reprinting since the line will be overwritten, not cleared.

fn progress(&self) -> i32

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

Sets the progress to the given value

fn add<P: Into<i32>>(&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<N: Debug> Debug for MappingBar<N>

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

Formats the value using the given formatter.

impl Default for MappingBar<usize>

fn default() -> Self

Returns the "default value" for a type.

impl Default for MappingBar<u32>

fn default() -> Self

Returns the "default value" for a type.

impl Default for MappingBar<i32>

fn default() -> Self

Returns the "default value" for a type.

impl Display for MappingBar<usize>

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

Formats the value using the given formatter.

impl Display for MappingBar<u32>

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

Formats the value using the given formatter.

impl Display for MappingBar<i32>

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

Formats the value using the given formatter.