Enum termprogress::silent::MaybeSilent

pub enum MaybeSilent<T> {
    Silent,
    Loud(T),
}

An enum wrapper for a progress bar or spinner that might be silent.

Variants

Silent

There is no progress

Loud(T)

There is progress

Implementations

impl<T> MaybeSilent<T>

pub fn is_loud(&self) -> bool

Is this the not silent variant?

pub fn is_silent(&self) -> bool

Is this the silent variant?

pub const fn new_some(value: T) -> Self

Create a new MaybeSilent with a value.

pub fn new<U>(from: U) -> Selfwhere U: Into<Option<T>>,

Create a new MaybeSilent with a potential value

pub fn as_ref(&self) -> Option<&T>

Get a reference to the inner type if possible

pub fn as_mut(&mut self) -> Option<&mut T>

Get a mutable reference to the inner type if possible

pub fn as_display_mut(&mut self) -> Option<&mut (dyn Display + 'static)>where T: Display + 'static,

Get a dynamic mutable reference to the internal value if it is Display.

pub fn into_inner(self) -> Option<T>

Consume this instance and return the inner value if possible

pub fn into_silent(self) -> Option<Silent>

Consume this instance and return silent if it had no value

pub fn as_bar_mut(&mut self) -> Option<&mut (dyn ProgressBar + 'static)>where T: ProgressBar + 'static,

Get a dynamic mutable reference to the internal value if it is ProgressBar

pub fn as_spinner_mut(&mut self) -> Option<&mut (dyn Spinner + 'static)>where T: Spinner + 'static,

Get a dynamic mutable reference to the internal value if it is Spinner.

pub fn as_display(&self) -> Option<&(dyn Display + 'static)>where T: Display + 'static,

Get a dynamic reference to the internal value if it is Display.

pub fn as_bar(&self) -> Option<&(dyn ProgressBar + 'static)>where T: ProgressBar + 'static,

Get a dynamic reference to the internal value if it is ProgressBar

pub fn as_spinner(&self) -> Option<&(dyn Spinner + 'static)>where T: Spinner + 'static,

Get a dynamic reference to the internal value if it is Spinner.

Trait Implementations

impl<T: Debug> Debug for MaybeSilent<T>

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

Formats the value using the given formatter.

impl<T> Display for MaybeSilent<T>where T: Display,

fn refresh(&self)

Refresh the display

fn blank(&self)

Blank the display

fn println(&self, string: &str)

Blank then print a line, and redisplay.

fn eprintln(&self, string: &str)

Blank then print a line std stderr, and redisplay.

fn get_title(&self) -> &str

Get the title for this display

fn set_title(&mut self, from: &str)

Set the title for this display

fn update_dimensions(&mut self, to: usize)

Update the max size if needed

impl<T> From<MaybeSilent<T>> for Option<T>

fn from(from: MaybeSilent<T>) -> Self

Converts to this type from the input type.

impl<T> From<Option<T>> for MaybeSilent<T>

fn from(from: Option<T>) -> Self

Converts to this type from the input type.

impl<T> ProgressBar for MaybeSilent<T>where T: ProgressBar,

fn set_progress(&mut self, value: f64)

fn get_progress(&self) -> f64

impl<T> Spinner for MaybeSilent<T>where T: Spinner,

fn bump(&mut self)

Cause the spinner to increment once.

impl<T> WithTitle for MaybeSilent<T>where T: WithTitle,

A trait for creating a progress bar or spinner with a title.

fn add_title(&mut self, string: impl AsRef<str>)

Add a title to this indicator.

fn with_title(self, string: impl AsRef<str>) -> Self

Add a title to this indicator.

fn update(&mut self)

fn complete(self)