Struct duration_human::DurationHuman

pub struct DurationHuman { /* private fields */ }

Define a Duration in human readable form

Examples

let duration = DurationHuman::try_from("80h").unwrap();
assert_eq!(format!("{:#}", duration), "3 days 8h".to_string());
assert_eq!(format!("{}", duration), "80h".to_string());
let duration = DurationHuman::try_from("72h").unwrap();
assert_eq!(format!("{:#}", duration), "3 days".to_string());
assert_eq!(format!("{}", duration), "3 days".to_string());
let duration = DurationHuman::try_from("18446744073709551615ns").unwrap();
assert_eq!(format!("{:#}", duration), "5 centuries 84 years 6 months 2 weeks 1 day 8h 34min 33s 709ms 551μs 615ns".to_string());
// roundtrip
let duration = DurationHuman::try_from("5 centuries 84 years 6 months 2 weeks 1 day 8h 34min 33s 709ms 551μs 615ns").unwrap();
let pretty = format!("{:#}", duration);
let duration_from_pretty = DurationHuman::try_from(pretty.as_str())?;
assert_eq!(duration, duration_from_pretty);
// precision is nano second
let duration = DurationHuman::try_from("604800μs").unwrap();
assert_eq!(format!("{:#}", duration), "604ms 800μs".to_string());
assert_eq!(duration.to_string(), "604800μs".to_string());
let duration = DurationHuman::try_from("604800ms").unwrap();
assert_eq!(format!("{:#}", duration), "10min 4s 800ms".to_string());
assert_eq!(duration.to_string(), "604800ms".to_string());
let duration = DurationHuman::try_from("604800s").unwrap();
assert_eq!(format!("{:#}", duration), "1 week".to_string());
let duration = DurationHuman::try_from("604800s").unwrap();
assert_eq!(format!("{:#}", duration), "1 week".to_string());
assert_eq!(format!("{}", duration), "1 week".to_string());
let duration = DurationHuman::try_from("608430s").unwrap();
assert_eq!(format!("{:#}", duration), "1 week 1h 30s".to_string());
assert_eq!(format!("{}", duration), "608430s".to_string());

Implementations

impl DurationHuman

pub const MICRO_SEC: u64 = 1_000u64

pub const MILLI_SEC: u64 = 1_000_000u64

pub const SEC: u64 = 1_000_000_000u64

pub const MINUTE: u64 = 60_000_000_000u64

pub const HOUR: u64 = 3_600_000_000_000u64

pub const DAY: u64 = 86_400_000_000_000u64

pub const WEEK: u64 = 604_800_000_000_000u64

pub const YEAR: u64 = 31_557_600_000_000_000u64

pub const MONTH: u64 = 2_629_800_000_000_000u64

pub const CENTURY: u64 = 3_155_760_000_000_000_000u64

pub const ONE_SECOND: Self = _

pub const ONE_MILLISECOND: Self = _

pub const fn new(nanos: u64) -> Self

pub fn parse(human_readable: &str) -> Result<Self, DurationError>

Create a new duration from a human redable string

Errors

DurationError when the parsing fails

pub fn is_in(&self, range: &DurationHumanValidator) -> bool

Trait Implementations

impl Add<Instant> for DurationHuman

fn add(self, rhs: Instant) -> Self::Output

Create a new std::time::Instant by adding one to this duration

Example

let instant = Instant::now();
let duration = DurationHuman::try_from("420s")?;
let after = duration + instant;
let diff = DurationHuman::from(after - instant);
assert_eq!(format!("{}", diff), format!("7min"));

type Output = Instant

The resulting type after applying the + operator.

impl Clone for DurationHuman

fn clone(&self) -> DurationHuman

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DurationHuman

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

Formats the value using the given formatter.

impl Default for DurationHuman

fn default() -> Self

Defaults to a 1min duration

impl Display for DurationHuman

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

Formats the value using the given formatter.

impl From<&DurationHuman> for Duration

fn from(duration: &DurationHuman) -> Self

For non human interaction features, just unwrap the std::time::Duration

Example

let duration = DurationHuman::try_from("5min")?;
let duration = std::time::Duration::from(&duration);
assert_eq!(duration.as_secs_f32(), 300_f32);

impl From<&DurationHuman> for u64

fn from(duration: &DurationHuman) -> Self

convert this duration into nano seconds

impl From<Duration> for DurationHuman

fn from(inner: Duration) -> Self

Converts to this type from the input type.

impl From<DurationHuman> for OsStr

fn from(duration: DurationHuman) -> Self

Converts to this type from the input type.

impl From<u64> for DurationHuman

fn from(nanos: u64) -> Self

Create a duration in nano seconds

impl Parse for DurationHuman

fn parse(input: ParseStream<'_>) -> Result<Self>

impl PartialEq<DurationHuman> for DurationHuman

fn eq(&self, other: &DurationHuman) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<DurationHuman> for DurationHuman

fn partial_cmp(&self, other: &DurationHuman) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for DurationHuman

type Error = DurationError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for DurationHuman

impl Eq for DurationHuman

impl StructuralEq for DurationHuman

impl StructuralPartialEq for DurationHuman