Struct indicatif::ProgressStyle
source · [−]pub struct ProgressStyle { /* private fields */ }
Expand description
Controls the rendering style of progress bars
Implementations
sourceimpl ProgressStyle
impl ProgressStyle
sourcepub fn default_bar() -> ProgressStyle
pub fn default_bar() -> ProgressStyle
Returns the default progress bar style for bars
sourcepub fn default_spinner() -> Self
pub fn default_spinner() -> Self
Returns the default progress bar style for spinners
pub fn with_template(template: &str) -> Result<Self, TemplateError>
sourcepub fn tick_chars(self, s: &str) -> ProgressStyle
pub fn tick_chars(self, s: &str) -> ProgressStyle
Sets the tick character sequence for spinners
sourcepub fn tick_strings(self, s: &[&str]) -> ProgressStyle
pub fn tick_strings(self, s: &[&str]) -> ProgressStyle
Sets the tick string sequence for spinners
sourcepub fn progress_chars(self, s: &str) -> ProgressStyle
pub fn progress_chars(self, s: &str) -> ProgressStyle
Sets the progress characters (filled, current, to do)
You can pass more than three for a more detailed display. All passed grapheme clusters need to be of equal width.
sourcepub fn with_key(
self,
key: &'static str,
f: fn(_: &ProgressState) -> String
) -> ProgressStyle
pub fn with_key(
self,
key: &'static str,
f: fn(_: &ProgressState) -> String
) -> ProgressStyle
Adds a custom key that references a &ProgressState
to the template
sourcepub fn template(self, s: &str) -> Result<ProgressStyle, TemplateError>
pub fn template(self, s: &str) -> Result<ProgressStyle, TemplateError>
Sets the template string for the progress bar
Review the list of template keys for more information.
sourcepub fn get_tick_str(&self, idx: u64) -> &str
pub fn get_tick_str(&self, idx: u64) -> &str
Returns the tick string for a given number
sourcepub fn get_final_tick_str(&self) -> &str
pub fn get_final_tick_str(&self) -> &str
Returns the tick string for the finished state
Trait Implementations
sourceimpl Clone for ProgressStyle
impl Clone for ProgressStyle
sourcefn clone(&self) -> ProgressStyle
fn clone(&self) -> ProgressStyle
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. 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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more