Expand description
This crate provides the TimeZone and DateTime structs, which can be used to determine local time on a given time zone.
This allows to convert between an Unix timestamp and a calendar time exprimed in the proleptic gregorian calendar with a provided time zone.
Time zones are provided to the library with a POSIX TZ string which can be read from the environment.
Two formats are currently accepted for the TZ string:
std offset[dst[offset][,start[/time],end[/time]]]providing a time zone description,fileor:fileproviding the path to a TZif file, which is absolute or relative to the system timezone directory.
Usage
Time zone
use tz::TimeZone;
// 2000-01-01T00:00:00Z
let unix_time = 946684800;
// Get UTC time zone
let time_zone_utc = TimeZone::utc();
assert_eq!(time_zone_utc.find_local_time_type(unix_time)?.ut_offset(), 0);
// Get fixed time zone at GMT-1
let time_zone_fixed = TimeZone::fixed(-3600);
assert_eq!(time_zone_fixed.find_local_time_type(unix_time)?.ut_offset(), -3600);
// Get local time zone (UNIX only)
let time_zone_local = TimeZone::local()?;
// Get the current local time type
let _current_local_time_type = time_zone_local.find_current_local_time_type()?;
// Get time zone from a TZ string:
// From an absolute file
let _ = TimeZone::from_posix_tz("/usr/share/zoneinfo/Pacific/Auckland");
// From a file relative to the system timezone directory
let _ = TimeZone::from_posix_tz("Pacific/Auckland");
// From a time zone description
TimeZone::from_posix_tz("HST10")?;
TimeZone::from_posix_tz("<-03>3")?;
TimeZone::from_posix_tz("NZST-12:00:00NZDT-13:00:00,M10.1.0,M3.3.0")?;
// Use a leading colon to force searching for a corresponding file
let _ = TimeZone::from_posix_tz(":UTC");Date time
use tz::{DateTime, TimeZone, UtcDateTime};
// Get the current UTC date time
let _current_utc_date_time = UtcDateTime::now()?;
// Create a new UTC date time (2000-01-01T00:00:00Z)
let utc_date_time = UtcDateTime::new(2000, 0, 1, 0, 0, 0)?;
assert_eq!(utc_date_time.second(), 0);
assert_eq!(utc_date_time.minute(), 0);
assert_eq!(utc_date_time.hour(), 0);
assert_eq!(utc_date_time.month_day(), 1);
assert_eq!(utc_date_time.month(), 0);
assert_eq!(utc_date_time.year(), 100);
assert_eq!(utc_date_time.full_year(), 2000);
assert_eq!(utc_date_time.week_day(), 6);
assert_eq!(utc_date_time.year_day(), 0);
assert_eq!(utc_date_time.unix_time(), 946684800);
// Create a new UTC date time from a Unix time (2000-01-01T00:00:00Z)
let other_utc_date_time = UtcDateTime::from_unix_time(946684800)?;
assert_eq!(other_utc_date_time, utc_date_time);
// Project the UTC date time to a time zone
let date_time = utc_date_time.project(&TimeZone::fixed(-3600))?;
assert_eq!(date_time.second(), 0);
assert_eq!(date_time.minute(), 0);
assert_eq!(date_time.hour(), 23);
assert_eq!(date_time.month_day(), 31);
assert_eq!(date_time.month(), 11);
assert_eq!(date_time.year(), 99);
assert_eq!(date_time.full_year(), 1999);
assert_eq!(date_time.week_day(), 5);
assert_eq!(date_time.year_day(), 364);
assert_eq!(date_time.local_time_type().ut_offset(), -3600);
assert_eq!(date_time.unix_time(), 946684800);
// Project the date time to another time zone
let other_date_time = date_time.project(&TimeZone::fixed(3600))?;
assert_eq!(other_date_time.second(), 0);
assert_eq!(other_date_time.minute(), 0);
assert_eq!(other_date_time.hour(), 1);
assert_eq!(other_date_time.month_day(), 1);
assert_eq!(other_date_time.month(), 0);
assert_eq!(other_date_time.year(), 100);
assert_eq!(other_date_time.full_year(), 2000);
assert_eq!(other_date_time.week_day(), 6);
assert_eq!(other_date_time.year_day(), 0);
assert_eq!(other_date_time.local_time_type().ut_offset(), 3600);
assert_eq!(other_date_time.unix_time(), 946684800);
// Get the current date time at the local time zone (UNIX only)
let time_zone_local = TimeZone::local()?;
let _date_time = DateTime::now(&time_zone_local)?;Structs
Date time associated to a local time type, exprimed in the proleptic gregorian calendar
Local time type associated to a time zone
Time zone
UTC date time exprimed in the proleptic gregorian calendar
Enums
Unified error type for everything in the crate
Type Definitions
Alias for std::result::Result with the crate unified error