Struct ProgressOptions

pub struct ProgressOptions {
    pub no_progress: bool,
    pub progress_interval: Option<Duration>,
}

Progress Bar Config

Fields

no_progress: bool

Don’t show any progress bar

progress_interval: Option<Duration>

Interval to update progress bars

Implementations

impl ProgressOptions

fn progress_interval(&self) -> Duration

Get the progress interval

Returns

Duration::ZERO if no progress is enabled

pub fn no_progress() -> RusticProgress

Create a hidden progress bar

Trait Implementations

impl Args for ProgressOptions

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for ProgressOptions

fn clone(&self) -> ProgressOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ProgressOptions

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for ProgressOptions

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

Formats the value using the given formatter.

impl Default for ProgressOptions

fn default() -> ProgressOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProgressOptions

where ProgressOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for ProgressOptions

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Merge for ProgressOptions

fn merge(&mut self, other: Self)

Merge another object into this object.

impl Parser for ProgressOptions

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl ProgressBars for ProgressOptions

type P = RusticProgress

The actual type which is able to show the progress

fn progress_spinner( &self, prefix: impl Into<Cow<'static, str>>, ) -> RusticProgress

Start a new progress spinner. Note that this progress doesn’t get a length and is not advanced, only finished.

fn progress_counter( &self, prefix: impl Into<Cow<'static, str>>, ) -> RusticProgress

Start a new progress which counts something

fn progress_hidden(&self) -> RusticProgress

Start a new progress, which is hidden

fn progress_bytes(&self, prefix: impl Into<Cow<'static, str>>) -> RusticProgress

Start a new progress which counts bytes

impl Serialize for ProgressOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ProgressOptions