1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
//! Simple Zero Sized Typed Utc timezones for [`chrono`].
//! This needs const generic (for rust >= 1.51 in stable).
//! ```rust
//! use chrono::*;
//! use chrono_simpletz::TimeZoneZst;
//! use chrono_simpletz::known_timezones::*;
//! use std::mem::size_of_val;
//!
//! //construct by new() or Default::default()
//! let p9 = UtcP9::new();
//! //size of UtcP9 is zero
//! assert_eq!(size_of_val(&p9), 0);
//! assert_eq!(&p9.to_string(), "+09:00");
//! assert_eq!(UtcP9::IS_IN_VALID_RANGE, true);
//!
//! let time = p9.with_ymd_and_hms(2000, 1, 1,12, 00, 00).unwrap();
//! let naive_time = NaiveDate::from_ymd_opt(2000, 1, 1).unwrap().and_hms(3, 0, 0);
//! assert_eq!(time.naive_utc(), naive_time);
//! //same size as naive datetime
//! assert_eq!(size_of_val(&time),size_of_val(&naive_time));
//!
//! let fixed = time.with_timezone(&p9.fix());
//! assert_eq!(time, fixed);
//! //same Display with FixedOffset
//! assert_eq!(time.to_string(), fixed.to_string());
//! // smaller size than FixedOffset size
//! assert!(size_of_val(&time) < size_of_val(&fixed) )
//! ```
//!
//! # features
//! ## std (default)
//! with std
//!
//! ## clock (default)
//! Adds today and now function for TimeZoneZst.
//!
//! ## serde
//! ### serde_ts_(seconds|milliseconds|nanoseconds)(|_option)
//! Adds modules for de/serialize functions to use with de/serialize_with function.
//!
//! ### serde_ts_rfc3339(|_option)
//! Adds modules for de/serialize functions to use with de/serialize_with function.
//! You need this when you want to de/serialize like `DateTime<Utc>`, because `DateTime<UtcZtc<H,M>>` cannot impl De/Serialize.
//!
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(doc_cfg, feature(doc_cfg))]
use chrono::*;
const HOUR_TO_SEC: i32 = 3600;
const MIN_TO_SEC: i32 = 60;
pub mod known_timezones;
#[cfg(feature = "serde")]
#[cfg_attr(doc_cfg, doc(cfg(feature = "serde")))]
pub mod serde;
/// Represent Fixed Timezone with zero sized type and const generics.
/// `HOUR` and `MINUTE` must be in valid range`(-23 <= HOUR <= 23 & MINUTE < 60)`, otherwise compile error will occur.
/// ```compile_fail
/// # use chrono::*;
/// # use chrono_simpletz::*;
/// let tz = TimeZoneZst::<26, 0>::new();
/// ```
#[derive(Clone, Copy, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub struct TimeZoneZst<const HOUR: i32, const MINUTE: u32>;
#[deprecated(since = "0.2.0", note = "Use `TimeZoneZst` instead.")]
pub type UtcZst<const HOUR: i32, const MINUTE: u32> = TimeZoneZst<HOUR, MINUTE>;
impl<const HOUR: i32, const MINUTE: u32> TimeZoneZst<HOUR, MINUTE> {
/// Gets the offset seconds. Should use [`FIXED_OFFSET`](`Self::FIXED_OFFSET`) instead of using this directory.
pub const OFFSET_SECS: i32 =
HOUR * HOUR_TO_SEC + if HOUR < 0 { -1 } else { 1 } * (MINUTE as i32) * MIN_TO_SEC;
/// Checks whether the `HOUR` and `MINUTE` is in valid range`(-23 <= HOUR <= 23 & MINUTE < 60)`. This does not check whether the timezone is known.
pub const IS_IN_VALID_RANGE: bool = (HOUR >= -23) & (HOUR <= 23) & (MINUTE < 60);
/// Gets the `FixedOffset` without creating a instance.
pub const FIXED_OFFSET: FixedOffset = match (
FixedOffset::east_opt(Self::OFFSET_SECS),
Self::IS_IN_VALID_RANGE,
) {
(Some(fix), true) => fix,
_ => panic!("Invalid TimeZone"),
};
/// Creates new `TimeZoneZst`
pub const fn new() -> Self {
// Check whether the time zone is in valid range.
let _ = Self::FIXED_OFFSET;
TimeZoneZst
}
#[cfg(feature = "clock")]
#[deprecated(since = "0.3.0")]
#[allow(deprecated)]
/// Returns a Date which corresponds to the current date. Only available with clock feature.
pub fn today() -> Date<Self> {
Utc::today().with_timezone(&Self::new())
}
#[cfg(feature = "clock")]
/// Returns a DateTime which corresponds to the current date. Only available with clock feature.
pub fn now() -> DateTime<Self> {
Utc::now().with_timezone(&Self::new())
}
}
impl<const HOUR: i32, const MINUTE: u32> Offset for TimeZoneZst<HOUR, MINUTE> {
fn fix(&self) -> FixedOffset {
Self::FIXED_OFFSET
}
}
impl<const HOUR: i32, const MINUTE: u32> TimeZone for TimeZoneZst<HOUR, MINUTE> {
type Offset = Self;
fn from_offset(offset: &Self::Offset) -> Self {
*offset
}
fn offset_from_local_date(&self, _local: &NaiveDate) -> LocalResult<Self::Offset> {
LocalResult::Single(*self)
}
fn offset_from_local_datetime(&self, _local: &NaiveDateTime) -> LocalResult<Self::Offset> {
LocalResult::Single(*self)
}
fn offset_from_utc_date(&self, _utc: &NaiveDate) -> Self::Offset {
*self
}
fn offset_from_utc_datetime(&self, _utc: &NaiveDateTime) -> Self::Offset {
*self
}
}
impl<const HOUR: i32, const MINUTE: u32> Default for TimeZoneZst<HOUR, MINUTE> {
fn default() -> Self {
Self::new()
}
}
impl<const HOUR: i32, const MINUTE: u32> core::fmt::Debug for TimeZoneZst<HOUR, MINUTE> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
write!(f, "{:+03}:{:02}", HOUR, MINUTE)
}
}
impl<const HOUR: i32, const MINUTE: u32> core::fmt::Display for TimeZoneZst<HOUR, MINUTE> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
write!(f, "{:+03}:{:02}", HOUR, MINUTE)
}
}
#[cfg(test)]
#[cfg(feature = "std")]
mod tests {
use crate::known_timezones::*;
use crate::*;
#[test]
fn display() {
let p9 = UtcP9::default();
assert_eq!(&p9.to_string(), "+09:00");
assert_eq!(std::mem::size_of_val(&p9), 0);
assert_eq!(UtcP9::IS_IN_VALID_RANGE, true);
let n = p9.with_ymd_and_hms(2000, 1, 1, 12, 00, 00).unwrap();
assert_eq!(
n.naive_utc(),
NaiveDate::from_ymd_opt(2000, 1, 1)
.unwrap()
.and_hms_opt(3, 0, 0)
.unwrap()
);
let m9 = UtcM9::default();
assert_eq!(&m9.to_string(), "-09:00");
let n = m9.with_ymd_and_hms(2000, 1, 1, 12, 00, 00).unwrap();
assert_eq!(
n.naive_utc(),
NaiveDate::from_ymd_opt(2000, 1, 1)
.unwrap()
.and_hms_opt(21, 0, 0)
.unwrap()
);
let p9 = UtcP9_30::default();
let n = p9.with_ymd_and_hms(2000, 1, 1, 12, 00, 00).unwrap();
assert_eq!(
n.naive_utc(),
NaiveDate::from_ymd_opt(2000, 1, 1)
.unwrap()
.and_hms_opt(2, 30, 0)
.unwrap()
);
let m9 = UtcM9_30::default();
let n = m9.with_ymd_and_hms(2000, 1, 1, 12, 00, 00).unwrap();
assert_eq!(
n.naive_utc(),
NaiveDate::from_ymd_opt(2000, 1, 1)
.unwrap()
.and_hms_opt(21, 30, 0)
.unwrap()
);
}
}