Enum FractionalUnit

#[non_exhaustive]
pub enum FractionalUnit {
    Hour,
    Minute,
    Second,
    Millisecond,
    Microsecond,
}

Available on crate features dep_jiff and alloc only.

Configuration for SpanPrinter::fractional.

This controls what kind of fractional unit to use when printing a duration. The default, unless SpanPrinter::hours_minutes_seconds is enabled, is to not write any fractional numbers at all.

The fractional unit set refers to the smallest whole integer that can occur in a “friendly” formatted duration. If there are any non-zero units less than the fractional unit in the duration, then they are formatted as a fraction.

Example

This example shows how to write the same duration with different fractional settings:

use jiff::{fmt::friendly::{FractionalUnit, SpanPrinter}, SignedDuration};

let duration = SignedDuration::from_secs(3663);

let printer = SpanPrinter::new()
    .fractional(Some(FractionalUnit::Hour));
assert_eq!(printer.duration_to_string(&duration), "1.0175h");

let printer = SpanPrinter::new()
    .fractional(Some(FractionalUnit::Minute));
assert_eq!(printer.duration_to_string(&duration), "1h 1.05m");

let printer = SpanPrinter::new()
    .fractional(Some(FractionalUnit::Second));
assert_eq!(printer.duration_to_string(&duration), "1h 1m 3s");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Hour

The smallest whole integer unit allowed is hours.

WARNING: Since fractional units are limited to 9 decimal places, using this setting could result in precision loss.

Minute

The smallest whole integer unit allowed is minutes.

WARNING: Since fractional units are limited to 9 decimal places, using this setting could result in precision loss.

Second

The smallest whole integer unit allowed is seconds.

Millisecond

The smallest whole integer unit allowed is milliseconds.

Microsecond

The smallest whole integer unit allowed is microseconds.

Trait Implementations

impl Clone for FractionalUnit

fn clone(&self) -> FractionalUnit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FractionalUnit

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

Formats the value using the given formatter.

impl From<FractionalUnit> for Unit

fn from(u: FractionalUnit) -> Unit

Converts to this type from the input type.

impl Copy for FractionalUnit