Struct chronoutil::relative_duration::RelativeDuration

pub struct RelativeDuration { /* private fields */ }

Relative time duration extending Chrono’s Duration.

Implementations

impl RelativeDuration

pub fn parse_from_iso8601(input: &str) -> Result<RelativeDuration, String>

Parses an ISO 8601 duration string into a RelativeDuration value.

This supports only duration strings with integer values (i.e "P1Y" but not "P0.5Y" or "P0,5Y"), as fractional values cannot be unambiguously represented as a RelativeDuration. The one exception to this is the seconds field, where the fractional part is truncated to 9 digits, and parsed as nanoseconds.

Errors

• Invalid duration string input
• Fractional values (apart from seconds) in duration string

Example

use chronoutil::RelativeDuration;

assert_eq!(
    RelativeDuration::parse_from_iso8601("P1Y").unwrap(),
    RelativeDuration::years(1),
);

pub fn format_to_iso8601(&self) -> String

Formats a RelativeDuration value into an ISO 8601 duration string.

Example

use chronoutil::RelativeDuration;

assert_eq!(
    RelativeDuration::years(1).format_to_iso8601(),
    "P1Y",
);

impl RelativeDuration

pub fn years(years: i32) -> RelativeDuration

Makes a new RelativeDuration with given number of years.

Equivalent to RelativeDuration::months(years * 12) with overflow checks. Panics when the duration is out of bounds.

pub fn months(months: i32) -> RelativeDuration

Makes a new RelativeDuration with given number of months. Panics when the duration is out of bounds.

pub fn weeks(weeks: i64) -> RelativeDuration

Makes a new RelativeDuration with given number of weeks. Panics when the duration is out of bounds.

pub fn days(days: i64) -> RelativeDuration

Makes a new RelativeDuration with given number of days. Panics when the duration is out of bounds.

pub fn hours(hours: i64) -> RelativeDuration

Makes a new RelativeDuration with given number of hours. Panics when the duration is out of bounds.

pub fn minutes(minutes: i64) -> RelativeDuration

Makes a new RelativeDuration with given number of minutes. Panics when the duration is out of bounds.

pub fn seconds(seconds: i64) -> RelativeDuration

Makes a new RelativeDuration with given number of seconds. Panics when the duration is out of bounds.

pub fn milliseconds(milliseconds: i64) -> RelativeDuration

Makes a new RelativeDuration with given number of milliseconds.

pub fn microseconds(microseconds: i64) -> RelativeDuration

Makes a new RelativeDuration with given number of microseconds.

pub fn nanoseconds(nanos: i64) -> RelativeDuration

Makes a new RelativeDuration with given number of nanoseconds.

pub fn with_duration(self, duration: Duration) -> RelativeDuration

Update the Duration part of the current RelativeDuration.

pub fn zero() -> RelativeDuration

A RelativeDuration representing zero.

pub fn is_zero(&self) -> bool

Returns true if the duration equals RelativeDuration::zero().

Trait Implementations

impl<Tz> Add<RelativeDuration> for Date<Tz>

where Tz: TimeZone,

type Output = Date<Tz>

The resulting type after applying the + operator.

fn add(self, rhs: RelativeDuration) -> Date<Tz>

Performs the + operation.

impl<Tz> Add<RelativeDuration> for DateTime<Tz>

where Tz: TimeZone,

type Output = DateTime<Tz>

The resulting type after applying the + operator.

fn add(self, rhs: RelativeDuration) -> DateTime<Tz>

Performs the + operation.

impl Add<RelativeDuration> for NaiveDate

type Output = NaiveDate

The resulting type after applying the + operator.

fn add(self, rhs: RelativeDuration) -> NaiveDate

Performs the + operation.

impl Add<RelativeDuration> for NaiveDateTime

type Output = NaiveDateTime

The resulting type after applying the + operator.

fn add(self, rhs: RelativeDuration) -> NaiveDateTime

Performs the + operation.

impl Add<RelativeDuration> for Duration

type Output = RelativeDuration

The resulting type after applying the + operator.

fn add(self, rhs: RelativeDuration) -> RelativeDuration

Performs the + operation.

impl Add<TimeDelta> for RelativeDuration

type Output = RelativeDuration

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> RelativeDuration

Performs the + operation.

impl Add for RelativeDuration

type Output = RelativeDuration

The resulting type after applying the + operator.

fn add(self, rhs: RelativeDuration) -> RelativeDuration

Performs the + operation.

impl Clone for RelativeDuration

fn clone(&self) -> RelativeDuration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelativeDuration

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

Formats the value using the given formatter.

impl Div<i32> for RelativeDuration

type Output = RelativeDuration

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> RelativeDuration

Performs the / operation.

impl From<Duration> for RelativeDuration

fn from(item: StdDuration) -> Self

Makes a new RelativeDuration from a std Duration.

impl From<TimeDelta> for RelativeDuration

fn from(item: Duration) -> Self

Makes a new RelativeDuration from a chrono::Duration.

impl Hash for RelativeDuration

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<i32> for RelativeDuration

type Output = RelativeDuration

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> RelativeDuration

Performs the * operation.

impl Neg for RelativeDuration

type Output = RelativeDuration

The resulting type after applying the - operator.

fn neg(self) -> RelativeDuration

Performs the unary - operation.

impl Ord for RelativeDuration

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

Restrict a value to a certain interval.

impl PartialEq for RelativeDuration

fn eq(&self, other: &RelativeDuration) -> 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 for RelativeDuration

fn partial_cmp(&self, other: &RelativeDuration) -> 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<Tz> Sub<RelativeDuration> for Date<Tz>

where Tz: TimeZone,

type Output = Date<Tz>

The resulting type after applying the - operator.

fn sub(self, rhs: RelativeDuration) -> Date<Tz>

Performs the - operation.

impl<Tz> Sub<RelativeDuration> for DateTime<Tz>

where Tz: TimeZone,

type Output = DateTime<Tz>

The resulting type after applying the - operator.

fn sub(self, rhs: RelativeDuration) -> DateTime<Tz>

Performs the - operation.

impl Sub<RelativeDuration> for NaiveDate

type Output = NaiveDate

The resulting type after applying the - operator.

fn sub(self, rhs: RelativeDuration) -> NaiveDate

Performs the - operation.

impl Sub<RelativeDuration> for NaiveDateTime

type Output = NaiveDateTime

The resulting type after applying the - operator.

fn sub(self, rhs: RelativeDuration) -> NaiveDateTime

Performs the - operation.

impl Sub<RelativeDuration> for Duration

type Output = RelativeDuration

The resulting type after applying the - operator.

fn sub(self, rhs: RelativeDuration) -> RelativeDuration

Performs the - operation.

impl Sub<TimeDelta> for RelativeDuration

type Output = RelativeDuration

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> RelativeDuration

Performs the - operation.

impl Sub for RelativeDuration

type Output = RelativeDuration

The resulting type after applying the - operator.

fn sub(self, rhs: RelativeDuration) -> RelativeDuration

Performs the - operation.

impl Copy for RelativeDuration

impl Eq for RelativeDuration

impl StructuralPartialEq for RelativeDuration