tzdb_data/
lib.rs

1// SPDX-License-Identifier: MIT-0
2//
3// Copyright 2022-2024 René Kijewski <crates.io@k6i.de>
4
5#![cfg_attr(docsrs, feature(doc_cfg))]
6#![allow(unknown_lints)]
7#![forbid(unsafe_code)]
8#![warn(absolute_paths_not_starting_with_crate)]
9#![warn(elided_lifetimes_in_paths)]
10#![warn(explicit_outlives_requirements)]
11#![warn(meta_variable_misuse)]
12#![warn(missing_copy_implementations)]
13#![warn(missing_debug_implementations)]
14#![warn(missing_docs)]
15#![warn(non_ascii_idents)]
16#![warn(noop_method_call)]
17#![warn(single_use_lifetimes)]
18#![warn(trivial_casts)]
19#![warn(unreachable_pub)]
20#![warn(unused_extern_crates)]
21#![warn(unused_lifetimes)]
22#![warn(unused_results)]
23#![allow(clippy::single_match_else)]
24#![allow(clippy::type_complexity)]
25#![no_std]
26
27//! # `tzdb_data` — Time Zone Database
28//!
29//! [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Kijewski/tzdb/ci.yml?branch=v0.7.x&style=flat-square&logo=github&logoColor=white "GitHub Workflow Status")](https://github.com/Kijewski/tzdb/actions/workflows/ci.yml)
30//! [![Crates.io](https://img.shields.io/crates/v/tzdb_data?logo=rust&style=flat-square "Crates.io")](https://crates.io/crates/tzdb_data)
31//! [![docs.rs](https://img.shields.io/docsrs/tzdb_data?logo=docsdotrs&style=flat-square&logoColor=white "docs.rs")](https://docs.rs/tzdb_data/)
32//! ![Minimum supported Rust version](https://img.shields.io/badge/rustc-1.81+-important?logo=rust&style=flat-square "Minimum Supported Rust Version: 1.81")
33//! [![License: MIT-0](https://img.shields.io/badge/license-MIT--0-informational?logo=apache&style=flat-square)](https://github.com/Kijewski/tzdb/blob/v0.6.1/tzdb_data/LICENSE.md "License: MIT-0")
34//!
35//! Static, `#![no_std]` time zone information for tz-rs
36//!
37//! This crate provides all time zones found in the [Time Zone Database](https://www.iana.org/time-zones).
38//!
39//! ## Usage examples
40//!
41//! ```rust
42//! // access by identifier
43//! let time_zone = tzdb_data::time_zone::europe::KYIV;
44//! // access by name
45//! let time_zone = tzdb_data::find_tz(b"Europe/Berlin").unwrap();
46//! // names are case insensitive
47//! let time_zone = tzdb_data::find_tz(b"ArCtIc/LoNgYeArByEn").unwrap();
48//! ```
49//!
50
51mod generated;
52
53#[doc(inline)]
54pub use crate::generated::{TZ_NAMES, VERSION, VERSION_HASH, time_zone};
55
56/// Find a time zone by name, e.g. `b"Europe/Berlin"` (case-insensitive)
57///
58/// # Example
59///
60/// ```
61/// assert_eq!(
62///     &tzdb_data::time_zone::europe::BERLIN,
63///     tzdb_data::find_tz(b"Europe/Berlin").unwrap(),
64/// );
65/// ```
66#[inline]
67#[must_use]
68pub const fn find_tz(s: &[u8]) -> Option<&'static tz::TimeZoneRef<'static>> {
69    match generated::by_name::find_key(s) {
70        Some(key) => Some(generated::by_name::TIME_ZONES[key as u16 as usize]),
71        None => None,
72    }
73}
74
75/// Find the raw, unparsed time zone data by name, e.g. `b"Europe/Berlin"` (case-insensitive)
76///
77/// # Example
78///
79/// ```
80/// assert_eq!(
81///     tzdb_data::time_zone::europe::RAW_BERLIN,
82///     tzdb_data::find_raw(b"Europe/Berlin").unwrap(),
83/// );
84/// ```
85#[inline]
86#[must_use]
87pub const fn find_raw(s: &[u8]) -> Option<&'static [u8]> {
88    match generated::by_name::find_key(s) {
89        Some(key) => Some(generated::by_name::RAW_TIME_ZONES[key as u16 as usize]),
90        None => None,
91    }
92}
93
94#[allow(clippy::ref_option)] // we cannot change `TimeZoneRef::new`'s interface
95#[must_use]
96const fn new_time_zone_ref(
97    transitions: &'static [tz::timezone::Transition],
98    local_time_types: &'static [tz::LocalTimeType],
99    leap_seconds: &'static [tz::timezone::LeapSecond],
100    extra_rule: &'static Option<tz::timezone::TransitionRule>,
101) -> tz::timezone::TimeZoneRef<'static> {
102    match tz::timezone::TimeZoneRef::new(transitions, local_time_types, leap_seconds, extra_rule) {
103        Ok(value) => value,
104        Err(_) => panic!(),
105    }
106}
107
108#[must_use]
109const fn new_local_time_type(
110    ut_offset: i32,
111    is_dst: bool,
112    time_zone_designation: Option<&[u8]>,
113) -> tz::LocalTimeType {
114    match tz::LocalTimeType::new(ut_offset, is_dst, time_zone_designation) {
115        Ok(value) => value,
116        Err(_) => panic!(),
117    }
118}
119
120#[must_use]
121const fn new_transition(
122    unix_leap_time: i64,
123    local_time_type_index: usize,
124) -> tz::timezone::Transition {
125    tz::timezone::Transition::new(unix_leap_time, local_time_type_index)
126}
127
128#[must_use]
129const fn new_alternate_time(
130    std: tz::LocalTimeType,
131    dst: tz::LocalTimeType,
132    dst_start: tz::timezone::RuleDay,
133    dst_start_time: i32,
134    dst_end: tz::timezone::RuleDay,
135    dst_end_time: i32,
136) -> tz::timezone::AlternateTime {
137    match tz::timezone::AlternateTime::new(
138        std,
139        dst,
140        dst_start,
141        dst_start_time,
142        dst_end,
143        dst_end_time,
144    ) {
145        Ok(value) => value,
146        Err(_) => panic!(),
147    }
148}
149
150#[must_use]
151const fn new_month_week_day(month: u8, week: u8, week_day: u8) -> tz::timezone::MonthWeekDay {
152    match tz::timezone::MonthWeekDay::new(month, week, week_day) {
153        Ok(value) => value,
154        Err(_) => panic!(),
155    }
156}
157
158// This implementation allows for invalid equalities like `b'-' == b'\x7f'`, but that's OK.
159//
160// The only troublesome characters are:
161//     @ -> `
162//     [ -> {
163//     \ -> |
164//     ] -> }
165//     ^ -> ~
166//     _ -> DEL
167//
168// None the these characters have a "false lower case" variant which can occur in the input.
169// This function is 40% faster than the variant in rust's core library, which is implemented
170// more strictly.
171#[inline]
172#[must_use]
173const fn eq_ignore_ascii_case(a: &[u8], b: &[u8]) -> bool {
174    if a.len() != b.len() {
175        return false;
176    }
177
178    // Cannot use for-loops in const fn.
179    let mut i = 0;
180    while i < a.len() {
181        if (a[i] | 0x20) != (b[i] | 0x20) {
182            return false;
183        }
184        i += 1;
185    }
186
187    true
188}
tzdb_data/lib.rs

tzdb_data/
lib.rs
