Struct PositiveDuration 

pub struct PositiveDuration(/* private fields */);

A duration is a unit of time that represents the amount of time required to complete a task.

Implementations

impl PositiveDuration

pub fn parse_from_str(s: &str) -> Result<Self, DurationError>

Tries to parse a string and return the corresponding [PositiveDuration]

Arguments

• s - The string to parse. Currently, only hours are supported in the format “X h”.

Returns

• Ok(PositiveDuration) - If the input string could be parsed into a PositiveDuration.
• Err(DurationError) - If the input string couldn’t be parsed into a PositiveDuration.

Errors

• DurationError::InvalidInput - If the input string couldn’t be parsed into a PositiveDuration.
• DurationError::ExceedsMaximumDuration - If the parsed duration exceeds the maximum allowed value.

Panics

This function uses expect, but it should only panic in case of a bug.

Examples

use planter_core::duration::PositiveDuration;

let duration = PositiveDuration::parse_from_str("8 h").unwrap();
assert_eq!(duration.num_hours(), 8);

use planter_core::duration::PositiveDuration;

/// Passing invalid input will result in an `[DurationError::InvalidInput]`
let duration = PositiveDuration::parse_from_str("random garbage").unwrap();

Trait Implementations

impl Clone for PositiveDuration

fn clone(&self) -> PositiveDuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PositiveDuration

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

Formats the value using the given formatter.

impl Default for PositiveDuration

fn default() -> PositiveDuration

Returns the “default value” for a type.

impl Deref for PositiveDuration

type Target = TimeDelta

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Ord for PositiveDuration

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

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

fn partial_cmp(&self, other: &PositiveDuration) -> 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 TryFrom<TimeDelta> for PositiveDuration

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

Creates a new PositiveDuration from a chrono::Duration.

type Error = DurationError

The type returned in the event of a conversion error.

impl Copy for PositiveDuration

impl Eq for PositiveDuration

impl StructuralPartialEq for PositiveDuration