Struct irox_time::Time

pub struct Time { /* private fields */ }

Represents a time of the day, an offset into the day from midnight.

Corresponds to a UTC of day in section 5.3.3 of ISO8601

Implementations

impl Time

pub fn new( second_of_day: u32, nanoseconds: u32 ) -> Result<Time, GreaterThanEqualToValueError<u32>>

Creates a Time from the specified seconds and nanoseconds,

The valid range of ‘second_of_day’ is 0..86400, The valid range of ‘nanoseconds’ is 0..1_000_000_000

pub fn from_seconds_f64( seconds: f64 ) -> Result<Time, GreaterThanEqualToValueError<f64>>

Creates a Time from the specified fractional seconds, valid range 0..86400

pub fn from_hms( hours: u8, minutes: u8, seconds: u8 ) -> Result<Time, GreaterThanEqualToValueError<u8>>

pub fn from_hms_f64( hours: u8, minutes: u8, seconds: f64 ) -> Result<Time, GreaterThanEqualToValueError<f64>>

pub fn from_hms_millis( hours: u8, minutes: u8, seconds: u8, millis: u32 ) -> Result<Time, GreaterThanEqualToValueError<u32>>

pub fn get_seconds(&self) -> u32

Returns the number of seconds into the “current day”

pub fn get_nanoseconds(&self) -> u32

Returns the number of fractional second nanoseconds

pub fn as_duration(&self) -> Duration

Converts this time into a duration

pub fn as_hours(&self) -> u32

Returns the number of hours represented by this time.

pub fn as_minutes(&self) -> u32

Returns the minute offset into the day represented by this time.

pub fn as_hms(&self) -> (u32, u32, u32)

Returns a triplet, (hours, minutes, seconds) representing this time

pub fn as_hms_f64(&self) -> (u32, u32, f64)

Returns a triplet, (hours, minutes, seconds) representing this time, with seconds as f64

pub fn get_secondsfrac(&self) -> f64

Returns ONLY the fractional seconds component of the timestamp

pub fn format<F: Format<Self>>(&self, format: &F) -> String

Formats this Time using the specified formatter

pub fn parse_from<F: FormatParser<Self>>( format: &F, string: &str ) -> Result<Self, FormatError>

Tries to parse a Time from the string using the specified Formatter

pub fn wrapping_add(&self, duration: Duration) -> (Time, Duration)

Adds the duration to this time, returning a new value of ‘time’. If the duration is longer than a single day, returns the number of days that got consumed in the second ‘duration’ parameter

Example:

    let time = Time::new(500, 0)?;
    let duration_to_add = Duration::from_seconds(129600); // 1.5 days
    let (time, excess) = time.wrapping_add(duration_to_add);

    assert_eq!(time, Time::new(43700, 0)?);
    assert_eq!(excess, Duration::from_days(1));

Trait Implementations

impl Clone for Time

fn clone(&self) -> Time

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Time

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

Formats the value using the given formatter.

impl Default for Time

fn default() -> Time

Returns the “default value” for a type.

impl Display for Time

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

Formats the value using the given formatter.

impl Format<Time> for BasicTimeOfDay

fn format(&self, date: &Time) -> String

Implementation-specific format of a date or time

impl Format<Time> for ExtendedTimeFormat

fn format(&self, date: &Time) -> String

Implementation-specific format of a date or time

impl FormatParser<Time> for BasicTimeOfDay

fn try_from(&self, data: &str) -> Result<Time, FormatError>

Tries to parse the specified string into the resultant item.

impl FormatParser<Time> for ExtendedTimeFormat

fn try_from(&self, data: &str) -> Result<Time, FormatError>

Tries to parse the specified string into the resultant item.

impl FormatParser<Time> for ISO8601Time

fn try_from(&self, data: &str) -> Result<Time, FormatError>

Tries to parse the specified string into the resultant item.

impl From<Time> for Duration

fn from(value: Time) -> Self

Converts to this type from the input type.

impl Ord for Time

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

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

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

impl Eq for Time

impl StructuralEq for Time

impl StructuralPartialEq for Time