Struct Config

pub struct Config<'a> {
    pub width: Option<u64>,
    pub default_width: u64,
    pub delimiters: (char, char),
    pub style: Style,
    pub space_char: char,
    pub prefix: &'a str,
    pub unit: &'a str,
    pub num_width: usize,
    pub throttle_millis: u64,
}

Fields

width: Option<u64>

default_width: u64

delimiters: (char, char)

style: Style

space_char: char

prefix: &'a str

unit: &'a str

num_width: usize

throttle_millis: u64

Implementations

impl Config<'_>

pub fn ascii() -> Self

pub fn unicode() -> Self

Examples found in repository

examples/example.rs (line 15)

fn main() {
	// Default
	for _ in progression::bar(0..1_000) {
		thread::sleep(Duration::from_millis(1));
	}

	// Cargo style
	for _ in progression::bar_with_config(0..1_000, progression::Config::cargo()) {
		thread::sleep(Duration::from_millis(1));
	}

	// Unicode style
	for _ in progression::bar_with_config(0..1_000, progression::Config::unicode()) {
		thread::sleep(Duration::from_millis(1));
	}

	// Uses `slice.chunks` internally for lower overhead on large numbers of items
	for _ in progression::bar_chunks(10, &[0; 1_000]) {
		thread::sleep(Duration::from_millis(1));
	}

	// Custom
	for _ in progression::bar_with_config(0..1_000, progression::Config { style: progression::Style::Mono('·'), ..Default::default() }) {
		thread::sleep(Duration::from_millis(1));
	}

	// Manual
	let items = vec![1, 2, 3, 4, 5];
	let bar = progression::Bar::new(items.len() as u64, progression::Config { prefix: "(items) ", ..progression::Config::cargo() });

	for _ in items {
		thread::sleep(Duration::from_millis(100));
		bar.inc(1);
	}

	bar.finish();
}

pub fn cargo() -> Self

Examples found in repository

examples/example.rs (line 10)

fn main() {
	// Default
	for _ in progression::bar(0..1_000) {
		thread::sleep(Duration::from_millis(1));
	}

	// Cargo style
	for _ in progression::bar_with_config(0..1_000, progression::Config::cargo()) {
		thread::sleep(Duration::from_millis(1));
	}

	// Unicode style
	for _ in progression::bar_with_config(0..1_000, progression::Config::unicode()) {
		thread::sleep(Duration::from_millis(1));
	}

	// Uses `slice.chunks` internally for lower overhead on large numbers of items
	for _ in progression::bar_chunks(10, &[0; 1_000]) {
		thread::sleep(Duration::from_millis(1));
	}

	// Custom
	for _ in progression::bar_with_config(0..1_000, progression::Config { style: progression::Style::Mono('·'), ..Default::default() }) {
		thread::sleep(Duration::from_millis(1));
	}

	// Manual
	let items = vec![1, 2, 3, 4, 5];
	let bar = progression::Bar::new(items.len() as u64, progression::Config { prefix: "(items) ", ..progression::Config::cargo() });

	for _ in items {
		thread::sleep(Duration::from_millis(100));
		bar.inc(1);
	}

	bar.finish();
}

Trait Implementations

impl<'a> Clone for Config<'a>

fn clone(&self) -> Config<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Config<'_>

fn default() -> Self

Returns the “default value” for a type.