Struct tz::DateTime

source ·

pub struct DateTime { /* private fields */ }

Expand description

Date time associated to a local time type, exprimed in the proleptic gregorian calendar

Implementations§

source §

impl DateTime

source

pub const fn new( year: i32, month: u8, month_day: u8, hour: u8, minute: u8, second: u8, nanoseconds: u32, local_time_type: LocalTimeType ) -> Result<Self, DateTimeError>

Construct a date time

§Inputs

year: Year
month: Month in [1, 12]
month_day: Day of the month in [1, 31]
hour: Hours since midnight in [0, 23]
minute: Minutes in [0, 59]
second: Seconds in [0, 60], with a possible leap second
nanoseconds: Nanoseconds in [0, 999_999_999]
local_time_type: Local time type associated to a time zone

source

pub fn find( year: i32, month: u8, month_day: u8, hour: u8, minute: u8, second: u8, nanoseconds: u32, time_zone_ref: TimeZoneRef<'_> ) -> Result<FoundDateTimeList, TzError>

Available on crate feature alloc only.

Find the possible date times corresponding to a date, a time and a time zone

§Inputs

year: Year
month: Month in [1, 12]
month_day: Day of the month in [1, 31]
hour: Hours since midnight in [0, 23]
minute: Minutes in [0, 59]
second: Seconds in [0, 60], with a possible leap second
nanoseconds: Nanoseconds in [0, 999_999_999]
time_zone_ref: Reference to a time zone

source

pub fn find_n<'a>( buf: &'a mut [Option<FoundDateTimeKind>], year: i32, month: u8, month_day: u8, hour: u8, minute: u8, second: u8, nanoseconds: u32, time_zone_ref: TimeZoneRef<'_> ) -> Result<FoundDateTimeListRefMut<'a>, TzError>

Find the possible date times corresponding to a date, a time and a time zone.

This method doesn’t allocate, and instead takes a preallocated buffer as an input. It returns a FoundDateTimeListRefMut wrapper which has additional methods.

§Inputs

buf: Preallocated buffer
year: Year
month: Month in [1, 12]
month_day: Day of the month in [1, 31]
hour: Hours since midnight in [0, 23]
minute: Minutes in [0, 59]
second: Seconds in [0, 60], with a possible leap second
nanoseconds: Nanoseconds in [0, 999_999_999]
time_zone_ref: Reference to a time zone

§Usage

use tz::datetime::{DateTime, FoundDateTimeKind};
use tz::timezone::{LocalTimeType, TimeZoneRef, Transition};

let transitions = &[Transition::new(3600, 1), Transition::new(86400, 0), Transition::new(i64::MAX, 0)];
let local_time_types = &[LocalTimeType::new(0, false, Some(b"STD"))?, LocalTimeType::new(3600, true, Some(b"DST"))?];
let time_zone_ref = TimeZoneRef::new(transitions, local_time_types, &[], &None)?;

// Buffer is too small, so the results are non exhaustive
let mut small_buf = [None; 1];
assert!(!DateTime::find_n(&mut small_buf, 1970, 1, 2, 0, 30, 0, 0, time_zone_ref)?.is_exhaustive());

// Fill buffer
let mut buf = [None; 2];
let found_date_time_list = DateTime::find_n(&mut buf, 1970, 1, 2, 0, 30, 0, 0, time_zone_ref)?;
let data = found_date_time_list.data();
assert!(found_date_time_list.is_exhaustive());
assert_eq!(found_date_time_list.count(), 2);
assert!(matches!(data, [Some(FoundDateTimeKind::Normal(..)), Some(FoundDateTimeKind::Normal(..))]));

// We can reuse the buffer
let found_date_time_list = DateTime::find_n(&mut buf, 1970, 1, 1, 1, 30, 0, 0, time_zone_ref)?;
let data = found_date_time_list.data();
assert!(found_date_time_list.is_exhaustive());
assert_eq!(found_date_time_list.count(), 1);
assert!(found_date_time_list.unique().is_none()); // FoundDateTimeKind::Skipped
assert!(matches!(data, &[Some(FoundDateTimeKind::Skipped { .. })]));