Struct sugar_cli::utils::ProgressStyle

source · [−]

pub struct ProgressStyle { /* private fields */ }

Expand description

Controls the rendering style of progress bars

Implementations

source

impl ProgressStyle

source

pub fn default_bar() -> ProgressStyle

Returns the default progress bar style for bars

source

pub fn default_spinner() -> ProgressStyle

Returns the default progress bar style for spinners

source

pub fn tick_chars(self, s: &str) -> ProgressStyle

Sets the tick character sequence for spinners

source

pub fn tick_strings(self, s: &[&str]) -> ProgressStyle

Sets the tick string sequence for spinners

source

pub fn progress_chars(self, s: &str) -> ProgressStyle

Sets the progress characters (filled, current, to do)

You can pass more then three for a more detailed display. All passed grapheme clusters need to be of equal width.

source

pub fn template(self, s: &str) -> ProgressStyle

Sets the template string for the progress bar

Review the list of template keys for more information.

source

pub fn on_finish(self, finish: ProgressFinish) -> ProgressStyle

Sets the finish behavior for the progress bar

This behavior is invoked when ProgressBar or ProgressBarIter completes and ProgressBar::is_finished() is false. If you don’t want the progress bar to be automatically finished then call on_finish(None).

source

pub fn get_tick_char(&self, idx: u64) -> char

👎Deprecated since 0.13.0:

Deprecated in favor of get_tick_str

Returns the tick char for a given number

source

pub fn get_tick_str(&self, idx: u64) -> &str

Returns the tick string for a given number

source

pub fn get_final_tick_char(&self) -> char

👎Deprecated since 0.13.0:

Deprecated in favor of get_final_tick_str

Returns the tick char for the finished state

source

pub fn get_final_tick_str(&self) -> &str

Returns the tick string for the finished state

source

pub fn get_on_finish(&self) -> &ProgressFinish

Returns the finish behavior

Trait Implementations

source

impl Clone for ProgressStyle

source

fn clone(&self) -> ProgressStyle

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for ProgressStyle

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for ProgressStyle

impl Send for ProgressStyle

impl Sync for ProgressStyle

impl Unpin for ProgressStyle

impl UnwindSafe for ProgressStyle

Blanket Implementations

impl<T> AbiExample for T

default fn example() -> T

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct sugar_cli::utils::ProgressStyle

Implementations

impl ProgressStyle

pub fn default_bar() -> ProgressStyle

pub fn default_spinner() -> ProgressStyle

pub fn tick_chars(self, s: &str) -> ProgressStyle

pub fn tick_strings(self, s: &[&str]) -> ProgressStyle

pub fn progress_chars(self, s: &str) -> ProgressStyle

pub fn template(self, s: &str) -> ProgressStyle

pub fn on_finish(self, finish: ProgressFinish) -> ProgressStyle

pub fn get_tick_char(&self, idx: u64) -> char

pub fn get_tick_str(&self, idx: u64) -> &str

pub fn get_final_tick_char(&self) -> char

pub fn get_final_tick_str(&self) -> &str

pub fn get_on_finish(&self) -> &ProgressFinish

Trait Implementations

impl Clone for ProgressStyle

fn clone(&self) -> ProgressStyle

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

impl Debug for ProgressStyle

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

Auto Trait Implementations

impl RefUnwindSafe for ProgressStyle

impl Send for ProgressStyle

impl Sync for ProgressStyle

impl Unpin for ProgressStyle

impl UnwindSafe for ProgressStyle

Blanket Implementations

impl<T> AbiExample for T

default fn example() -> T

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,