Struct Config

pub struct Config {
    pub prefix: Cow<'static, str>,
    pub total: Option<f64>,
    pub leave: bool,
    pub disable: bool,
    pub unit: Cow<'static, str>,
    pub unit_scale: f64,
    pub postfix: Cow<'static, str>,
    pub colour: Cow<'static, str>,
    pub progress_chars: Cow<'static, str>,
}

Configuration for the Tqdm and ParTqdm progress bars.

Fields

prefix: Cow<'static, str>

Placed at the start of the progress bar (default = “”)

total: Option<f64>

Expected number of iterations (default = iter.len())

leave: bool

Whether or not to leave the progress bar behind after completion (default = true)

disable: bool

Hides the progress bar (default = false)

unit: Cow<'static, str>

Measurement type used for it/s (default = “it”)

unit_scale: f64

Scales the it/s, position, and total numbers. (default = 1)

postfix: Cow<'static, str>

Placed at the end of the progress bar (default = “”)

colour: Cow<'static, str>

Color used for the progress bar (default = “white”)

progress_chars: Cow<'static, str>

Characters used for displaying the progress bar.

Implementations

impl Config

pub const fn new() -> Self

Examples found in repository

examples/multiple.rs (line 4)

fn main() {
    let config = Config::new().with_progress_chars(">= ");
    std::thread::scope(|scope| {
        for _ in 0..3 {
            scope.spawn(|| for _ in (0..2 << 24).tqdm_config(config.clone()) {});
        }
    });
}

examples/config.rs (line 5)

fn main() {
    let config = simple_tqdm::Config::new()
        .with_desc("[]")
        .with_total(500)
        .with_disable(false)
        .with_leave(true)
        .with_unit("num")
        .with_scale(0.5)
        .with_postfix("hi")
        .with_color("cyan")
        .with_disable(true)
        .with_progress_chars(">= ");

    for _ in (0..250).tqdm_config(config) {
        std::thread::sleep(Duration::from_millis(10));
    }
}

pub fn with_prefix(self, prefix: impl Into<Cow<'static, str>>) -> Self

Placed at the start of the progress bar (default = “”)

pub fn with_desc(self, desc: impl Into<Cow<'static, str>>) -> Self

Placed at the start of the progress bar (default = “”) Like tqdm this method adds “: “ to the end of the prefix.

Examples found in repository

examples/config.rs (line 6)

fn main() {
    let config = simple_tqdm::Config::new()
        .with_desc("[]")
        .with_total(500)
        .with_disable(false)
        .with_leave(true)
        .with_unit("num")
        .with_scale(0.5)
        .with_postfix("hi")
        .with_color("cyan")
        .with_disable(true)
        .with_progress_chars(">= ");

    for _ in (0..250).tqdm_config(config) {
        std::thread::sleep(Duration::from_millis(10));
    }
}

pub fn with_total(self, total: u64) -> Self

Expected number of iterations (default = iter.len())

Examples found in repository

examples/config.rs (line 7)

fn main() {
    let config = simple_tqdm::Config::new()
        .with_desc("[]")
        .with_total(500)
        .with_disable(false)
        .with_leave(true)
        .with_unit("num")
        .with_scale(0.5)
        .with_postfix("hi")
        .with_color("cyan")
        .with_disable(true)
        .with_progress_chars(">= ");

    for _ in (0..250).tqdm_config(config) {
        std::thread::sleep(Duration::from_millis(10));
    }
}

pub fn with_total_float(self, total: f64) -> Self

Expected number of iterations (default = iter.len())

pub fn with_leave(self, leave: bool) -> Self

Whether or not to leave the progress bar behind after completion (default = true)

Examples found in repository

examples/config.rs (line 9)

fn main() {
    let config = simple_tqdm::Config::new()
        .with_desc("[]")
        .with_total(500)
        .with_disable(false)
        .with_leave(true)
        .with_unit("num")
        .with_scale(0.5)
        .with_postfix("hi")
        .with_color("cyan")
        .with_disable(true)
        .with_progress_chars(">= ");

    for _ in (0..250).tqdm_config(config) {
        std::thread::sleep(Duration::from_millis(10));
    }
}

pub fn with_disable(self, disable: bool) -> Self

Hides the progress bar (default = false)

Examples found in repository

examples/config.rs (line 8)

fn main() {
    let config = simple_tqdm::Config::new()
        .with_desc("[]")
        .with_total(500)
        .with_disable(false)
        .with_leave(true)
        .with_unit("num")
        .with_scale(0.5)
        .with_postfix("hi")
        .with_color("cyan")
        .with_disable(true)
        .with_progress_chars(">= ");

    for _ in (0..250).tqdm_config(config) {
        std::thread::sleep(Duration::from_millis(10));
    }
}

pub fn with_unit(self, unit: impl Into<Cow<'static, str>>) -> Config

Measurement type used for it/s (default = “it”)

Examples found in repository

examples/config.rs (line 10)

fn main() {
    let config = simple_tqdm::Config::new()
        .with_desc("[]")
        .with_total(500)
        .with_disable(false)
        .with_leave(true)
        .with_unit("num")
        .with_scale(0.5)
        .with_postfix("hi")
        .with_color("cyan")
        .with_disable(true)
        .with_progress_chars(">= ");

    for _ in (0..250).tqdm_config(config) {
        std::thread::sleep(Duration::from_millis(10));
    }
}

pub fn with_scale(self, scale: impl Into<f64>) -> Config

Scales the it/s, position, and total numbers. (default = 1)

Examples found in repository

examples/config.rs (line 11)

fn main() {
    let config = simple_tqdm::Config::new()
        .with_desc("[]")
        .with_total(500)
        .with_disable(false)
        .with_leave(true)
        .with_unit("num")
        .with_scale(0.5)
        .with_postfix("hi")
        .with_color("cyan")
        .with_disable(true)
        .with_progress_chars(">= ");

    for _ in (0..250).tqdm_config(config) {
        std::thread::sleep(Duration::from_millis(10));
    }
}

pub fn with_postfix(self, postfix: impl Into<Cow<'static, str>>) -> Config

Placed at the end of the progress bar (default = “”)

Examples found in repository

examples/config.rs (line 12)

fn main() {
    let config = simple_tqdm::Config::new()
        .with_desc("[]")
        .with_total(500)
        .with_disable(false)
        .with_leave(true)
        .with_unit("num")
        .with_scale(0.5)
        .with_postfix("hi")
        .with_color("cyan")
        .with_disable(true)
        .with_progress_chars(">= ");

    for _ in (0..250).tqdm_config(config) {
        std::thread::sleep(Duration::from_millis(10));
    }
}

pub fn with_color(self, colour: impl Into<Cow<'static, str>>) -> Config

Color used for the progress bar (default = “white”)

Examples found in repository

examples/config.rs (line 13)

fn main() {
    let config = simple_tqdm::Config::new()
        .with_desc("[]")
        .with_total(500)
        .with_disable(false)
        .with_leave(true)
        .with_unit("num")
        .with_scale(0.5)
        .with_postfix("hi")
        .with_color("cyan")
        .with_disable(true)
        .with_progress_chars(">= ");

    for _ in (0..250).tqdm_config(config) {
        std::thread::sleep(Duration::from_millis(10));
    }
}

pub fn with_progress_chars( self, progress_chars: impl Into<Cow<'static, str>>, ) -> Config

Characters used for displaying the progress bar.

Examples found in repository

examples/multiple.rs (line 4)

fn main() {
    let config = Config::new().with_progress_chars(">= ");
    std::thread::scope(|scope| {
        for _ in 0..3 {
            scope.spawn(|| for _ in (0..2 << 24).tqdm_config(config.clone()) {});
        }
    });
}

examples/config.rs (line 15)

fn main() {
    let config = simple_tqdm::Config::new()
        .with_desc("[]")
        .with_total(500)
        .with_disable(false)
        .with_leave(true)
        .with_unit("num")
        .with_scale(0.5)
        .with_postfix("hi")
        .with_color("cyan")
        .with_disable(true)
        .with_progress_chars(">= ");

    for _ in (0..250).tqdm_config(config) {
        std::thread::sleep(Duration::from_millis(10));
    }
}

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Config

fn partial_cmp(&self, other: &Config) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Config