Struct PrettyDuration 

pub struct PrettyDuration {
    text: String,
    duration: Duration,
}

A duration parsed from a human-readable value.

Format: ( [NUMBER][UNIT] [SPACE]? )+

Unit:

• Seconds: s|sec|secs|seconds
• Minutes: m|min|mins|minutes
• Hours: h|hour|hours
• Days: d|day|days

Examples: 30s, 1m30s, 1m 30s, 2hours, 7d.

Resolution is one second; there are no sub-second units.

The spelling a value was parsed from is preserved, so a config that is read and written back keeps the author’s formatting. Values constructed in code are formatted with the largest units that divide them evenly.

Fields

text: String

The text this value was parsed from, or the formatting of a value constructed in code. Always re-parses to the same duration.

duration: Duration

Implementations

impl PrettyDuration

pub fn new(duration: Duration) -> Self

Sub-second precision is truncated, since no unit can express it and the spelling and the value would otherwise disagree.

pub fn as_duration(&self) -> Duration

pub fn as_str(&self) -> &str

The spelling this value was parsed from or formatted as.

pub fn from_secs(secs: u64) -> Self

pub fn from_mins(mins: u64) -> Self

Saturates at u64::MAX seconds, matching Self::from_hours and Self::from_days. Parsing rejects that magnitude instead, because there the amount comes from a config file rather than from a caller.

pub fn from_hours(hours: u64) -> Self

Saturates at u64::MAX seconds. See Self::from_mins.

pub fn from_days(days: u64) -> Self

Saturates at u64::MAX seconds. See Self::from_mins.

Trait Implementations

impl Clone for PrettyDuration

fn clone(&self) -> PrettyDuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrettyDuration

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

Formats the value using the given formatter.

impl Default for PrettyDuration

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PrettyDuration

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PrettyDuration

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

Formats the value using the given formatter.

impl From<Duration> for PrettyDuration

fn from(duration: Duration) -> Self

Converts to this type from the input type.

impl From<PrettyDuration> for Duration

fn from(duration: PrettyDuration) -> Self

Converts to this type from the input type.

impl FromStr for PrettyDuration

type Err = PrettyDurationParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for PrettyDuration

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for PrettyDuration

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for PrettyDuration

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PrettyDuration

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for PrettyDuration

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for PrettyDuration

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PrettyDuration