Struct TimeTuple

pub struct TimeTuple { /* private fields */ }

A wrapper for a particular time of day.

Precise to second-level.

NOTE: This cannot be 24 hours or greater - see TimeTuple::new() for more details.

The wrapping described in TimeTuple::new() also applies when adding and subtracting times.

Implementations

impl TimeTuple

pub fn new(h: i32, m: i32, s: i32) -> TimeTuple

Produces a new TimeTuple.

Times of 24 hours or greater and negative times will wrap around 24 hours to always produce a positive time.

The value is calculated from total number of seconds so a time with a minute value of 90 would add an hour to the resulting tuple and set the minutes to 30, for example.

pub fn from_seconds(total_seconds: u64) -> TimeTuple

Same as TimeTuple::new() but takes the total number of seconds as its argument and calculates the hours, minutes, and seconds from that.

pub fn now() -> TimeTuple

Returns a TimeTuple of the current time as std::time::SystemTime provides it.

pub fn get_hours(self) -> u8

pub fn get_minutes(self) -> u8

pub fn get_seconds(self) -> u8

pub fn to_hhmm_string(self) -> String

Produces a string such as 08:30 for 8 hours and 30 minutes.

Ignores seconds.

pub fn to_seconds(self) -> u32

Gets the total number of seconds in the tuple.

pub fn to_minutes(self) -> u32

Gets the total number of minutes in the tuple, ignoring seconds.

pub fn add_seconds(&mut self, seconds: i32)

Adds a number of seconds to the TimeTuple, wrapping the same way TimeTuple::new() does.

pub fn subtract_seconds(&mut self, seconds: i32)

Subtracts a number of seconds from the TimeTuple, wrapping the same way TimeTuple::new() does.

pub fn add_minutes(&mut self, minutes: i32)

Adds a number of minutes to the TimeTuple, wrapping the same way TimeTuple::new() does.

pub fn subtract_minutes(&mut self, minutes: i32)

Subtracts a number of minutes from the TimeTuple, wrapping the same way TimeTuple::new() does.

pub fn add_hours(&mut self, hours: i32)

Adds a number of hours to the TimeTuple, wrapping the same way TimeTuple::new() does.

pub fn subtract_hours(&mut self, hours: i32)

Subtracts a number of hours from the TimeTuple, wrapping the same way TimeTuple::new() does.

Trait Implementations

impl Add for TimeTuple

type Output = TimeTuple

The resulting type after applying the + operator.

fn add(self, other: TimeTuple) -> TimeTuple

Performs the + operation.

impl AddAssign for TimeTuple

fn add_assign(&mut self, other: TimeTuple)

Performs the += operation.

impl Clone for TimeTuple

fn clone(&self) -> TimeTuple

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeTuple

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

Formats the value using the given formatter.

impl Display for TimeTuple

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

Formats the value using the given formatter.

impl From<TimeTuple> for Duration

fn from(time: TimeTuple) -> Self

Converts to this type from the input type.

impl FromStr for TimeTuple

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<TimeTuple, Self::Err>

Parses a string s to return a value of this type.

impl Hash for TimeTuple

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 Ord for TimeTuple

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

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

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

type Output = TimeTuple

The resulting type after applying the - operator.

fn sub(self, other: TimeTuple) -> TimeTuple

Performs the - operation.

impl SubAssign for TimeTuple

fn sub_assign(&mut self, other: TimeTuple)

Performs the -= operation.

impl Copy for TimeTuple

impl Eq for TimeTuple

impl StructuralPartialEq for TimeTuple