Struct Options 

#[non_exhaustive]
pub struct Options {

    pub colon_notation: bool,
    pub compact: bool,
    pub verbose: bool,
    pub separate_milliseconds: bool,
    pub format_sub_milliseconds: bool,
    pub sub_seconds_as_decimals: bool,
    pub hide_year: bool,
    pub hide_year_and_days: bool,
    pub hide_seconds: bool,
    pub keep_decimals_on_whole_seconds: bool,
    pub unit_count: Option<usize>,
    pub seconds_decimal_digits: Option<usize>,
    pub milliseconds_decimal_digits: Option<usize>,
}

Formatting options, mirroring the pretty-ms npm package. Construct with Options::default and the builder methods:

use pretty_ms::Options;
let opts = Options::default().compact(true);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

colon_notation: bool

Use colon notation: 5h 1m 45s becomes 5:01:45.

compact: bool

Only show the first unit: 1h 10m becomes 1h. Implies unit_count = 1 and no decimals.

verbose: bool

Use full-length unit names: 5h 1m 45s becomes 5 hours 1 minute 45 seconds.

separate_milliseconds: bool

Show milliseconds separately instead of as part of the seconds.

format_sub_milliseconds: bool

Show sub-millisecond units (microseconds, nanoseconds).

sub_seconds_as_decimals: bool

Show sub-second values as a decimal fraction of seconds even below 1 second.

hide_year: bool

Do not show the year unit (days are not divided into years).

hide_year_and_days: bool

Do not show year or day units (hours accumulate instead).

hide_seconds: bool

Do not show the seconds unit.

keep_decimals_on_whole_seconds: bool

Keep the decimals on whole seconds: 3s becomes 3.0s.

unit_count: Option<usize>

Limit the number of units shown.

seconds_decimal_digits: Option<usize>

Number of digits after the decimal point for seconds (default 1). Beyond 15 digits the extra places are zeros (the precision limit of f64), and counts above 100 are clamped to 100.

milliseconds_decimal_digits: Option<usize>

Number of digits after the decimal point for milliseconds (default 0).

Implementations

impl Options

pub fn colon_notation(self, value: bool) -> Self

See Options::colon_notation.

pub fn compact(self, value: bool) -> Self

See Options::compact.

pub fn verbose(self, value: bool) -> Self

See Options::verbose.

pub fn separate_milliseconds(self, value: bool) -> Self

See Options::separate_milliseconds.

pub fn format_sub_milliseconds(self, value: bool) -> Self

See Options::format_sub_milliseconds.

pub fn sub_seconds_as_decimals(self, value: bool) -> Self

See Options::sub_seconds_as_decimals.

pub fn hide_year(self, value: bool) -> Self

See Options::hide_year.

pub fn hide_year_and_days(self, value: bool) -> Self

See Options::hide_year_and_days.

pub fn hide_seconds(self, value: bool) -> Self

See Options::hide_seconds.

pub fn keep_decimals_on_whole_seconds(self, value: bool) -> Self

See Options::keep_decimals_on_whole_seconds.

pub fn unit_count(self, value: usize) -> Self

See Options::unit_count.

pub fn seconds_decimal_digits(self, value: usize) -> Self

See Options::seconds_decimal_digits.

pub fn milliseconds_decimal_digits(self, value: usize) -> Self

See Options::milliseconds_decimal_digits.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.