Struct Style

pub struct Style { /* private fields */ }

Progress bar style

Implementations

impl Style

pub fn new() -> Self

Default progress bar style

Example

Create a progress bar, explicitly asking for the default style:

let style = logbar::Style::new();
let max_progress = 100;
let bar = logbar::ProgressBar::with_style(max_progress, style);

pub fn width(self, width: usize) -> Self

Set the progress bar width in characters

Example

Create a progress bar with a width of 80 characters:

let style = logbar::Style::new().width(80);
let max_progress = 100;
let bar = logbar::ProgressBar::with_style(max_progress, style);

pub fn labels(self, labels: bool) -> Self

Toggle progress bar labels of the form XX%

Example

Create a progress bar without labels:

let style = logbar::Style::new().labels(false);
let max_progress = 100;
let bar = logbar::ProgressBar::with_style(max_progress, style);

pub fn tick(self, tick: char) -> Self

Choose a “tick” character separating the progress bar segments

Example

Create a progress bar with ‘↓’ as tick character:

let style = logbar::Style::new().tick('↓');
let max_progress = 100;
let bar = logbar::ProgressBar::with_style(max_progress, style);

pub fn bar(self, bar: char) -> Self

Choose a character for the progress bar segments

Example

Create a progress bar made out of ‘-’ characters, separated by the default “tick” character.

let style = logbar::Style::new().bar('-');
let max_progress = 100;
let bar = logbar::ProgressBar::with_style(max_progress, style);

pub fn indicator(self, indicator: char) -> Self

Choose a progress indicator

Example

Create a progress bar where the progress is indicated by the number of ‘█’ characters.

let style = logbar::Style::new().indicator('█');
let max_progress = 100;
let bar = logbar::ProgressBar::with_style(max_progress, style);

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Style

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

Formats the value using the given formatter.

impl Default for Style

fn default() -> Self

Default progress bar style

Example

Create a progress bar, explicitly asking for the default style:

let style = logbar::Style::default();
let max_progress = 100;
let bar = logbar::ProgressBar::with_style(max_progress, style);

impl Hash for Style

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Style

fn cmp(&self, other: &Style) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Style

fn eq(&self, other: &Style) -> 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 Style

fn partial_cmp(&self, other: &Style) -> 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 Eq for Style

impl StructuralPartialEq for Style