Struct time::Time

pub struct Time { /* fields omitted */ }

The clock time within a given date. Nanosecond precision.

All minutes are assumed to have exactly 60 seconds; no attempt is made to handle leap seconds (either positive or negative).

When comparing two Times, they are assumed to be in the same calendar date.

Implementations

impl Time

pub const MIDNIGHT: Self

Create a Time that is exactly midnight.

assert_eq!(Time::MIDNIGHT, time!("0:00"));

pub const fn from_hms(
    hour: u8,
    minute: u8,
    second: u8
) -> Result<Self, ComponentRange>

Attempt to create a Time from the hour, minute, and second.

assert!(Time::from_hms(1, 2, 3).is_ok());

assert!(Time::from_hms(24, 0, 0).is_err()); // 24 isn't a valid hour.
assert!(Time::from_hms(0, 60, 0).is_err()); // 60 isn't a valid minute.
assert!(Time::from_hms(0, 0, 60).is_err()); // 60 isn't a valid second.

pub const fn from_hms_milli(
    hour: u8,
    minute: u8,
    second: u8,
    millisecond: u16
) -> Result<Self, ComponentRange>

Attempt to create a Time from the hour, minute, second, and millisecond.

assert!(Time::from_hms_milli(1, 2, 3, 4).is_ok());

assert!(Time::from_hms_milli(24, 0, 0, 0).is_err()); // 24 isn't a valid hour.
assert!(Time::from_hms_milli(0, 60, 0, 0).is_err()); // 60 isn't a valid minute.
assert!(Time::from_hms_milli(0, 0, 60, 0).is_err()); // 60 isn't a valid second.
assert!(Time::from_hms_milli(0, 0, 0, 1_000).is_err()); // 1_000 isn't a valid millisecond.

pub const fn from_hms_micro(
    hour: u8,
    minute: u8,
    second: u8,
    microsecond: u32
) -> Result<Self, ComponentRange>

Attempt to create a Time from the hour, minute, second, and microsecond.

assert!(Time::from_hms_micro(1, 2, 3, 4).is_ok());

assert!(Time::from_hms_micro(24, 0, 0, 0).is_err()); // 24 isn't a valid hour.
assert!(Time::from_hms_micro(0, 60, 0, 0).is_err()); // 60 isn't a valid minute.
assert!(Time::from_hms_micro(0, 0, 60, 0).is_err()); // 60 isn't a valid second.
assert!(Time::from_hms_micro(0, 0, 0, 1_000_000).is_err()); // 1_000_000 isn't a valid microsecond.

pub const fn from_hms_nano(
    hour: u8,
    minute: u8,
    second: u8,
    nanosecond: u32
) -> Result<Self, ComponentRange>

Attempt to create a Time from the hour, minute, second, and nanosecond.

assert!(Time::from_hms_nano(1, 2, 3, 4).is_ok());

assert!(Time::from_hms_nano(24, 0, 0, 0).is_err()); // 24 isn't a valid hour.
assert!(Time::from_hms_nano(0, 60, 0, 0).is_err()); // 60 isn't a valid minute.
assert!(Time::from_hms_nano(0, 0, 60, 0).is_err()); // 60 isn't a valid second.
assert!(Time::from_hms_nano(0, 0, 0, 1_000_000_000).is_err()); // 1_000_000_000 isn't a valid nanosecond.

pub const fn as_hms(self) -> (u8, u8, u8)

Get the clock hour, minute, and second.

assert_eq!(time!("0:00:00").as_hms(), (0, 0, 0));
assert_eq!(time!("23:59:59").as_hms(), (23, 59, 59));

pub const fn as_hms_milli(self) -> (u8, u8, u8, u16)

Get the clock hour, minute, second, and millisecond.

assert_eq!(time!("0:00:00").as_hms_milli(), (0, 0, 0, 0));
assert_eq!(time!("23:59:59.999").as_hms_milli(), (23, 59, 59, 999));

pub const fn as_hms_micro(self) -> (u8, u8, u8, u32)

Get the clock hour, minute, second, and microsecond.

assert_eq!(time!("0:00:00").as_hms_micro(), (0, 0, 0, 0));
assert_eq!(
    time!("23:59:59.999_999").as_hms_micro(),
    (23, 59, 59, 999_999)
);

pub const fn as_hms_nano(self) -> (u8, u8, u8, u32)

Get the clock hour, minute, second, and nanosecond.

assert_eq!(time!("0:00:00").as_hms_nano(), (0, 0, 0, 0));
assert_eq!(
    time!("23:59:59.999_999_999").as_hms_nano(),
    (23, 59, 59, 999_999_999)
);

pub const fn hour(self) -> u8

Get the clock hour.

The returned value will always be in the range 0..24.

assert_eq!(time!("0:00:00").hour(), 0);
assert_eq!(time!("23:59:59").hour(), 23);

pub const fn minute(self) -> u8

Get the minute within the hour.

The returned value will always be in the range 0..60.

assert_eq!(time!("0:00:00").minute(), 0);
assert_eq!(time!("23:59:59").minute(), 59);

pub const fn second(self) -> u8

Get the second within the minute.

The returned value will always be in the range 0..60.

assert_eq!(time!("0:00:00").second(), 0);
assert_eq!(time!("23:59:59").second(), 59);

pub const fn millisecond(self) -> u16

Get the milliseconds within the second.

The returned value will always be in the range 0..1_000.

assert_eq!(time!("0:00").millisecond(), 0);
assert_eq!(time!("23:59:59.999").millisecond(), 999);

pub const fn microsecond(self) -> u32

Get the microseconds within the second.

The returned value will always be in the range 0..1_000_000.

assert_eq!(time!("0:00").microsecond(), 0);
assert_eq!(time!("23:59:59.999_999").microsecond(), 999_999);

pub const fn nanosecond(self) -> u32

Get the nanoseconds within the second.

The returned value will always be in the range 0..1_000_000_000.

assert_eq!(time!("0:00").nanosecond(), 0);
assert_eq!(time!("23:59:59.999_999_999").nanosecond(), 999_999_999);

impl Time

pub fn format_into(
    self,
    output: &mut impl Write,
    format: &impl Formattable
) -> Result<usize, Format>

This is supported on crate feature formatting only.

Format the Time using the provided format description. The formatted value will be output to the provided writer. The format description will typically be parsed by using format_description::parse.

pub fn format(self, format: &impl Formattable) -> Result<String, Format>

This is supported on crate feature formatting only.

Format the Time using the provided format description. The format description will typically be parsed by using format_description::parse.

let format = format_description::parse("[hour]:[minute]:[second]")?;
assert_eq!(time!("12:00").format(&format)?, "12:00:00");

impl Time

pub fn parse(input: &str, description: &impl Parsable) -> Result<Self, Parse>

This is supported on crate feature parsing only.

Parse a Time from the input using the provided format description. The format description will typically be parsed by using format_description::parse.

let format = format_description::parse("[hour]:[minute]:[second]")?;
assert_eq!(Time::parse("12:00:00", &format)?, time!("12:00"));

Trait Implementations

impl Add<Duration> for Time

type Output = Self

The resulting type after applying the + operator.

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

Add the sub-day time of the Duration to the Time. Wraps on overflow.

assert_eq!(time!("12:00") + 2.hours(), time!("14:00"));
assert_eq!(time!("0:00:01") + (-2).seconds(), time!("23:59:59"));

impl Add<Duration> for Time

type Output = Self

The resulting type after applying the + operator.

fn add(self, duration: StdDuration) -> Self::Output

Add the sub-day time of the std::time::Duration to the Time. Wraps on overflow.

assert_eq!(time!("12:00") + 2.std_hours(), time!("14:00"));
assert_eq!(time!("23:59:59") + 2.std_seconds(), time!("0:00:01"));

impl<T> AddAssign<T> for Time where
    Self: Add<T, Output = Self>, 

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Arbitrary for Time

This is supported on crate feature quickcheck only.

fn arbitrary(g: &mut Gen) -> Self

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself.

impl Clone for Time

fn clone(&self) -> Time

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Time

impl Debug for Time

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

Formats the value using the given formatter.

impl<'a> Deserialize<'a> for Time

This is supported on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for Time

This is supported on crate feature formatting only.

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

Formats the value using the given formatter.

impl Eq for Time

impl Hash for Time

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Time

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Time> 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: &Time) -> bool

This method tests for !=.

impl PartialOrd<Time> for Time

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub 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 Serialize for Time

This is supported on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Time

impl StructuralPartialEq for Time

impl Sub<Duration> for Time

type Output = Self

The resulting type after applying the - operator.

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

Subtract the sub-day time of the Duration from the Time. Wraps on overflow.

assert_eq!(time!("14:00") - 2.hours(), time!("12:00"));
assert_eq!(time!("23:59:59") - (-2).seconds(), time!("0:00:01"));

impl Sub<Duration> for Time

type Output = Self

The resulting type after applying the - operator.

fn sub(self, duration: StdDuration) -> Self::Output

Subtract the sub-day time of the std::time::Duration from the Time. Wraps on overflow.

assert_eq!(time!("14:00") - 2.std_hours(), time!("12:00"));
assert_eq!(time!("0:00:01") - 2.std_seconds(), time!("23:59:59"));

impl Sub<Time> for Time

type Output = Duration

The resulting type after applying the - operator.

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

Subtract two Times, returning the Duration between. This assumes both Times are in the same calendar day.

assert_eq!(time!("0:00") - time!("0:00"), 0.seconds());
assert_eq!(time!("1:00") - time!("0:00"), 1.hours());
assert_eq!(time!("0:00") - time!("1:00"), (-1).hours());
assert_eq!(time!("0:00") - time!("23:00"), (-23).hours());

impl<T> SubAssign<T> for Time where
    Self: Sub<T, Output = Self>, 

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl TryFrom<Parsed> for Time

This is supported on crate feature parsing only.

type Error = TryFromParsed

The type returned in the event of a conversion error.

fn try_from(parsed: Parsed) -> Result<Self, Self::Error>

Performs the conversion.