Struct hourglass::Datetime

pub struct Datetime<'a> { /* fields omitted */ }

A precise point in time along associated to a Timezone.

The Datetime cannot be created on its own as it depends on a Timezone. hourglass does not expose a naive flavor of Datetime. To build a Datetime, instanciate a Timezone first and call the desired method.

let paris = hourglass::Timezone::new("Europe/Paris").unwrap();
let midnight_in_paris = paris.datetime(2015, 12, 25, 0, 0, 0, 0).unwrap();

let utc = hourglass::Timezone::utc();
let t = midnight_in_paris.project(&utc);

assert_eq!(t.date(), (2015, 12, 24));
assert_eq!(t.time(), (23, 0, 0, 0));

Methods

impl<'a> Datetime<'a>

pub fn project<'b>(&self, tz: &'b Timezone) -> Datetime<'b>

Project the current Datetime in another Timezone.

pub fn date(&self) -> (i32, i32, i32)

Return the date component of the Datetime expressed in the associated Timezone. The tuple holds the year, month and day in this order.

pub fn time(&self) -> (i32, i32, i32, i32)

Return the time component of the Datetime expressed in the associated Timezone. The tuple holds the hour, minute, second and nanosecond in this order.

pub fn unix(&self) -> i64

Return the unix timestamp. This is the number of unix seconds since 1970-01-01T00:00:00Z.

pub fn to_timespec(&self) -> Timespec

Convert the Datetime to a Timespec, disregarding the Timezone. The associated Timezone does not have any impact on the resulting Timespec. Therefore, as long as two Datetime with different Timezone match the same point in time, their resulting Timespec will be equal.

pub fn format(&self, fmt: &str) -> Result<String, FmtError>

Format the Datetime according to the provided format. The following control characters are implemented:

• %%: the '%' character
• %Y: year (2006)
• %m: month (01)
• %d: day of the month (02)
• %e: day of the month (2)
• %H: hour (15)
• %M: minute (04)
• %S: second (05)
• %3: millisecond (123)
• %6: microsecond (123456)
• %9: nanosecond (123456789)
• %x: UTC offset (+02:00 or -05:00)
• %z: UTC offset (+0200 or -0500)
• %Z: timezone abbreviation (CET)
• %w: weekday (1)
• %a: abbreviated weekday name (Mon)
• %A: full weekday name (Monday)
• %b: abbreviated month name (Jan)
• %B: full month name (January)
• %C: century (20)

Returns a FmtError if the format is invalid.

pub fn rfc3339(&self) -> String

Format Datetime according to RFC 3339 format.

pub fn rfc2822(&self) -> String

Format Datetime according to RFC 2822 format.

Trait Implementations

impl<'a> PartialOrd<Datetime<'a>> for Datetime<'a>

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

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

#[must_use]

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

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

#[must_use]

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]

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

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

#[must_use]

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<'a> Copy for Datetime<'a>

impl<'a> PartialEq<Datetime<'a>> for Datetime<'a>

fn eq(&self, other: &Datetime) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl<'a> Clone for Datetime<'a>

fn clone(&self) -> Datetime<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Ord for Datetime<'a>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> Eq for Datetime<'a>

impl<'a> Debug for Datetime<'a>

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a> Add<Deltatime> for Datetime<'a>

type Output = Datetime<'a>

The resulting type after applying the + operator.

fn add(self, rhs: Deltatime) -> Self::Output

Performs the + operation.

impl<'a> Sub<Deltatime> for Datetime<'a>

type Output = Datetime<'a>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<Datetime<'a>> for Datetime<'a>

type Output = Deltatime

The resulting type after applying the - operator.

fn sub(self, rhs: Datetime<'a>) -> Self::Output

Performs the - operation.