Struct DurationFlex 

pub struct DurationFlex { /* private fields */ }

Type to conveniently specify durations and interoperate with chrono::Duration.

The correct way of building this, is through one of the from methods.

With the clap feature, can be used with [clap]:

use clap::Args;
use duration_flex::DurationFlex;

#[derive(Args)]
pub struct Arguments {
	#[arg(long, default_value_t = Arguments::default().duration)]
	duration: DurationFlex,
}

impl Default for Arguments {
	fn default() -> Self {
		Self { duration: DurationFlex::try_from("1w6d23h49m59s").unwrap() }
	}
}

Implementations

impl DurationFlex

pub const ZERO: DurationFlex

A duration of zero seconds.

pub const fn new(secs: i64, nanos: i32) -> Self

Creates a new DurationFlex from seconds and nanoseconds.

pub const fn from_secs(secs: i64) -> Self

Creates a new DurationFlex from a whole number of seconds.

pub const fn from_millis(millis: i64) -> Self

Creates a new DurationFlex from a whole number of milliseconds.

pub const fn from_minutes(minutes: i64) -> Self

Creates a new DurationFlex from a whole number of minutes.

pub const fn from_hours(hours: i64) -> Self

Creates a new DurationFlex from a whole number of hours.

pub const fn from_days(days: i64) -> Self

Creates a new DurationFlex from a whole number of days.

pub const fn from_weeks(weeks: i64) -> Self

Creates a new DurationFlex from a whole number of weeks.

pub const fn from_years(years: i64) -> Self

Creates a new DurationFlex from a whole number of years (365 days each).

pub const fn is_zero(&self) -> bool

Returns true if the duration is zero.

pub const fn is_positive(&self) -> bool

Returns true if the duration is positive (> 0).

pub const fn is_negative(&self) -> bool

Returns true if the duration is negative (< 0).

pub fn to_std(&self) -> Option<Duration>

Converts this duration into a std::time::Duration if non-negative.

pub fn to_chrono(&self) -> Duration

Converts this duration into a chrono::Duration.

pub fn secs(&self) -> i64

Whole seconds.

pub fn nanos(&self) -> i32

Nano-seconds.

Trait Implementations

impl Add for DurationFlex

type Output = DurationFlex

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<DateTime<T>> for DurationFlex

where T: TimeZone,

type Output = DateTime<T>

The resulting type after applying the + operator.

fn add(self, rhs: DateTime<T>) -> Self::Output

Performs the + operation.

impl<T> Add<DurationFlex> for DateTime<T>

where T: TimeZone,

type Output = DateTime<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<TimeDelta> for DurationFlex

type Output = TimeDelta

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for DurationFlex

fn clone(&self) -> DurationFlex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DurationFlex

impl Debug for DurationFlex

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

Formats the value using the given formatter.

impl Default for DurationFlex

fn default() -> DurationFlex

Returns the “default value” for a type.

impl Display for DurationFlex

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

Formats the value using the given formatter.

impl Div<i64> for DurationFlex

type Output = DurationFlex

The resulting type after applying the / operator.

fn div(self, rhs: i64) -> Self::Output

Performs the / operation.

impl Div<u32> for DurationFlex

type Output = DurationFlex

The resulting type after applying the / operator.

fn div(self, rhs: u32) -> Self::Output

Performs the / operation.

impl Eq for DurationFlex

impl From<Duration> for DurationFlex

fn from(value: Duration) -> Self

Converts to this type from the input type.

impl From<DurationFlex> for Duration

fn from(value: DurationFlex) -> Self

Converts to this type from the input type.

impl From<DurationFlex> for Duration

fn from(value: DurationFlex) -> Self

Converts to this type from the input type.

impl From<String> for DurationFlex

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<TimeDelta> for DurationFlex

fn from(value: Duration) -> Self

Converts to this type from the input type.

impl FromStr for DurationFlex

type Err = DurationFlexError

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 DurationFlex

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 Mul<i64> for DurationFlex

type Output = DurationFlex

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> Self::Output

Performs the * operation.

impl Mul<u32> for DurationFlex

type Output = DurationFlex

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Self::Output

Performs the * operation.

impl Ord for DurationFlex

fn cmp(&self, other: &DurationFlex) -> 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 DurationFlex

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DurationFlex

fn partial_cmp(&self, other: &DurationFlex) -> 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 StructuralPartialEq for DurationFlex

impl Sub for DurationFlex

type Output = DurationFlex

The resulting type after applying the - operator.

fn sub(self, rhs: DurationFlex) -> Self::Output

Performs the - operation.

impl<T> Sub<DurationFlex> for DateTime<T>

where T: TimeZone,

type Output = DateTime<T>

The resulting type after applying the - operator.

fn sub(self, rhs: DurationFlex) -> Self::Output

Performs the - operation.

impl Sub<TimeDelta> for DurationFlex

type Output = TimeDelta

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> Self::Output

Performs the - operation.

impl Sum for DurationFlex

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<'a> Sum<&'a DurationFlex> for DurationFlex

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<&str> for DurationFlex

type Error = DurationFlexError

The type returned in the event of a conversion error.

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

Performs the conversion.