jiff/tz/db/mod.rs
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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
use crate::{
error::{err, Error},
tz::TimeZone,
util::sync::Arc,
};
mod bundled;
mod concatenated;
mod zoneinfo;
/// Returns a copy of the global [`TimeZoneDatabase`].
///
/// This is the same database used for convenience routines like
/// [`Timestamp::in_tz`](crate::Timestamp::in_tz) and parsing routines
/// for [`Zoned`](crate::Zoned) that need to do IANA time zone identifier
/// lookups. Basically, whenever an implicit time zone database is needed,
/// it is *this* copy of the time zone database that is used.
///
/// In feature configurations where a time zone database cannot interact with
/// the file system (like when `std` is not enabled), this returns a database
/// where every lookup will fail.
///
/// # Example
///
/// ```
/// use jiff::tz;
///
/// assert!(tz::db().get("Antarctica/Troll").is_ok());
/// assert!(tz::db().get("does-not-exist").is_err());
/// ```
pub fn db() -> &'static TimeZoneDatabase {
#[cfg(not(feature = "std"))]
{
static NONE: TimeZoneDatabase = TimeZoneDatabase::none();
&NONE
}
#[cfg(feature = "std")]
{
use std::sync::OnceLock;
static DB: OnceLock<TimeZoneDatabase> = OnceLock::new();
DB.get_or_init(|| {
let db = TimeZoneDatabase::from_env();
debug!("initialized global time zone database: {db:?}");
db
})
}
}
/// A handle to a [IANA Time Zone Database].
///
/// A `TimeZoneDatabase` provides a way to lookup [`TimeZone`]s by their
/// human readable identifiers, such as `America/Los_Angeles` and
/// `Europe/Warsaw`.
///
/// It is rare to need to create or use this type directly. Routines
/// like zoned datetime parsing and time zone conversion provide
/// convenience routines for using an implicit global time zone database
/// by default. This global time zone database is available via
/// [`jiff::tz::db`](crate::tz::db()`). But lower level parsing routines
/// such as
/// [`fmt::temporal::DateTimeParser::parse_zoned_with`](crate::fmt::temporal::DateTimeParser::parse_zoned_with)
/// and
/// [`civil::DateTime::to_zoned`](crate::civil::DateTime::to_zoned) provide a
/// means to use a custom copy of a `TimeZoneDatabase`.
///
/// # Platform behavior
///
/// This behavior is subject to change.
///
/// On Unix systems, and when the `tzdb-zoneinfo` crate feature is enabled
/// (which it is by default), Jiff will read the `/usr/share/zoneinfo`
/// directory for time zone data.
///
/// On Windows systems and when the `tzdb-bundle-platform` crate feature is
/// enabled (which it is by default), _or_ when the `tzdb-bundle-always` crate
/// feature is enabled, then the `jiff-tzdb` crate will be used to embed the
/// entire Time Zone Database into the compiled artifact.
///
/// On Android systems, and when the `tzdb-concatenated` crate feature is
/// enabled (which it is by default), Jiff will attempt to read a concatenated
/// zoneinfo database using the `ANDROID_DATA` or `ANDROID_ROOT` environment
/// variables.
///
/// In general, using `/usr/share/zoneinfo` (or an equivalent) is heavily
/// preferred in lieu of embedding the database into your compiled artifact.
/// The reason is because your system copy of the Time Zone Database may be
/// updated, perhaps a few times a year, and it is better to get seamless
/// updates through your system rather than needing to wait on a Rust crate
/// to update and then rebuild your software. The bundling approach should
/// only be used when there is no plausible alternative. For example, Windows
/// has no canonical location for a copy of the Time Zone Database. Indeed,
/// this is why the Cargo configuration of Jiff specifically does not enabled
/// bundling by default on Unix systems, but does enable it by default on
/// Windows systems. Of course, if you really do need a copy of the database
/// bundled, then you can enable the `tzdb-bundle-always` crate feature.
///
/// # Cloning
///
/// A `TimeZoneDatabase` can be cheaply cloned. It will share a thread safe
/// cache with other copies of the same `TimeZoneDatabase`.
///
/// # Caching
///
/// Because looking up a time zone on disk, reading the file into memory
/// and parsing the time zone transitions out of that file requires
/// a fair amount of work, a `TimeZoneDatabase` does a fair bit of
/// caching. This means that the vast majority of calls to, for example,
/// [`Timestamp::in_tz`](crate::Timestamp::in_tz) don't actually need to hit
/// disk. It will just find a cached copy of a [`TimeZone`] and return that.
///
/// Of course, with caching comes problems of cache invalidation. Invariably,
/// there are parameters that Jiff uses to manage when the cache should be
/// invalidated. Jiff tries to emit log messages about this when it happens. If
/// you find the caching behavior of Jiff to be sub-optimal for your use case,
/// please create an issue. (The plan is likely to expose some options for
/// configuring the behavior of a `TimeZoneDatabase`, but I wanted to collect
/// user feedback first.)
///
/// [IANA Time Zone Database]: https://en.wikipedia.org/wiki/Tz_database
///
/// # Example: list all available time zones
///
/// ```no_run
/// use jiff::tz;
///
/// for tzid in tz::db().available() {
/// println!("{tzid}");
/// }
/// ```
///
/// # Example: using multiple time zone databases
///
/// Jiff supports opening and using multiple time zone databases by default.
/// All you need to do is point [`TimeZoneDatabase::from_dir`] to your own
/// copy of the Time Zone Database, and it will handle the rest.
///
/// This example shows how to utilize multiple databases by parsing a datetime
/// using an older copy of the IANA Time Zone Database. This example leverages
/// the fact that the 2018 copy of the database preceded Brazil's announcement
/// that daylight saving time would be abolished. This meant that datetimes
/// in the future, when parsed with the older copy of the Time Zone Database,
/// would still follow the old daylight saving time rules. But a mere update of
/// the database would otherwise change the meaning of the datetime.
///
/// This scenario can come up if one stores datetimes in the future. This is
/// also why the default offset conflict resolution strategy when parsing zoned
/// datetimes is [`OffsetConflict::Reject`](crate::tz::OffsetConflict::Reject),
/// which prevents one from silently re-interpreting datetimes to a different
/// timestamp.
///
/// ```no_run
/// use jiff::{fmt::temporal::DateTimeParser, tz::{self, TimeZoneDatabase}};
///
/// static PARSER: DateTimeParser = DateTimeParser::new();
///
/// // Open a version of tzdb from before Brazil announced its abolition
/// // of daylight saving time.
/// let tzdb2018 = TimeZoneDatabase::from_dir("path/to/tzdb-2018b")?;
/// // Open the system tzdb.
/// let tzdb = tz::db();
///
/// // Parse the same datetime string with the same parser, but using two
/// // different versions of tzdb.
/// let dt = "2020-01-15T12:00[America/Sao_Paulo]";
/// let zdt2018 = PARSER.parse_zoned_with(&tzdb2018, dt)?;
/// let zdt = PARSER.parse_zoned_with(tzdb, dt)?;
///
/// // Before DST was abolished, 2020-01-15 was in DST, which corresponded
/// // to UTC offset -02. Since DST rules applied to datetimes in the
/// // future, the 2018 version of tzdb would lead one to interpret
/// // 2020-01-15 as being in DST.
/// assert_eq!(zdt2018.offset(), tz::offset(-2));
/// // But DST was abolished in 2019, which means that 2020-01-15 was no
/// // no longer in DST. So after a tzdb update, the same datetime as above
/// // now has a different offset.
/// assert_eq!(zdt.offset(), tz::offset(-3));
///
/// // So if you try to parse a datetime serialized from an older copy of
/// // tzdb, you'll get an error under the default configuration because
/// // of `OffsetConflict::Reject`. This would succeed if you parsed it
/// // using tzdb2018!
/// assert!(PARSER.parse_zoned_with(tzdb, zdt2018.to_string()).is_err());
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[derive(Clone)]
pub struct TimeZoneDatabase {
inner: Option<Arc<Kind>>,
}
#[derive(Debug)]
// Needed for core-only "dumb" `Arc`.
#[cfg_attr(not(feature = "alloc"), derive(Clone))]
enum Kind {
ZoneInfo(zoneinfo::Database),
Concatenated(concatenated::Database),
Bundled(bundled::Database),
}
impl TimeZoneDatabase {
/// Returns a database for which all time zone lookups fail.
///
/// # Example
///
/// ```
/// use jiff::tz::TimeZoneDatabase;
///
/// let db = TimeZoneDatabase::none();
/// assert_eq!(db.available().count(), 0);
/// ```
pub const fn none() -> TimeZoneDatabase {
TimeZoneDatabase { inner: None }
}
/// Returns a time zone database initialized from the current environment.
///
/// This routine never fails, but it may not be able to find a copy of
/// your Time Zone Database. When this happens, log messages (with some
/// at least at the `WARN` level) will be emitted. They can be viewed by
/// installing a [`log`] compatible logger such as [`env_logger`].
///
/// Typically, one does not need to call this routine directly. Instead,
/// it's done for you as part of [`jiff::tz::db`](crate::tz::db()).
/// This does require Jiff's `std` feature to be enabled though. So for
/// example, you might use this constructor when the features `alloc`
/// and `tzdb-bundle-always` are enabled to get access to a bundled
/// copy of the IANA time zone database. (Accessing the system copy at
/// `/usr/share/zoneinfo` requires `std`.)
///
/// Beware that calling this constructor will create a new _distinct_
/// handle from the one returned by `jiff::tz::db` with its own cache.
///
/// [`log`]: https://docs.rs/log
/// [`env_logger`]: https://docs.rs/env_logger
///
/// # Platform behavior
///
/// When the `TZDIR` environment variable is set, this will attempt to
/// open the Time Zone Database at the directory specified. Otherwise,
/// this will search a list of predefined directories for a system
/// installation of the Time Zone Database. Typically, it's found at
/// `/usr/share/zoneinfo`.
///
/// On Windows systems, under the default crate configuration, this will
/// return an embedded copy of the Time Zone Database since Windows does
/// not have a canonical installation of the Time Zone Database.
pub fn from_env() -> TimeZoneDatabase {
// On Android, try the concatenated database first, since that's
// typically what is used.
//
// Overall this logic might be sub-optimal. Like, does it really make
// sense to check for the zoneinfo or concatenated database on non-Unix
// platforms? Probably not to be honest. But these should only be
// executed ~once generally, so it doesn't seem like a big deal to try.
// And trying makes things a little more flexible I think.
if cfg!(target_os = "android") {
let db = concatenated::Database::from_env();
if !db.is_definitively_empty() {
return TimeZoneDatabase::new(Kind::Concatenated(db));
}
let db = zoneinfo::Database::from_env();
if !db.is_definitively_empty() {
return TimeZoneDatabase::new(Kind::ZoneInfo(db));
}
} else {
let db = zoneinfo::Database::from_env();
if !db.is_definitively_empty() {
return TimeZoneDatabase::new(Kind::ZoneInfo(db));
}
let db = concatenated::Database::from_env();
if !db.is_definitively_empty() {
return TimeZoneDatabase::new(Kind::Concatenated(db));
}
}
let db = bundled::Database::new();
if !db.is_definitively_empty() {
return TimeZoneDatabase::new(Kind::Bundled(db));
}
warn!(
"could not find zoneinfo, concatenated tzdata or \
bundled time zone database",
);
TimeZoneDatabase::none()
}
/// Returns a time zone database initialized from the given directory.
///
/// Unlike [`TimeZoneDatabase::from_env`], this always attempts to look for
/// a copy of the Time Zone Database at the directory given. And if it
/// fails to find one at that directory, then an error is returned.
///
/// Basically, you should use this when you need to use a _specific_
/// copy of the Time Zone Database, and use `TimeZoneDatabase::from_env`
/// when you just want Jiff to try and "do the right thing for you."
///
/// # Errors
///
/// This returns an error if the given directory does not contain a valid
/// copy of the Time Zone Database. Generally, this means a directory with
/// at least one valid TZif file.
#[cfg(feature = "std")]
pub fn from_dir<P: AsRef<std::path::Path>>(
path: P,
) -> Result<TimeZoneDatabase, Error> {
let path = path.as_ref();
let db = zoneinfo::Database::from_dir(path)?;
if db.is_definitively_empty() {
warn!(
"could not find zoneinfo data at directory {path}",
path = path.display(),
);
}
Ok(TimeZoneDatabase::new(Kind::ZoneInfo(db)))
}
/// Returns a time zone database initialized from a path pointing to a
/// concatenated `tzdata` file. This type of format is only known to be
/// found on Android environments. The specific format for this file isn't
/// defined formally anywhere, but Jiff parses the same format supported
/// by the [Android Platform].
///
/// Unlike [`TimeZoneDatabase::from_env`], this always attempts to look for
/// a copy of the Time Zone Database at the path given. And if it
/// fails to find one at that path, then an error is returned.
///
/// Basically, you should use this when you need to use a _specific_
/// copy of the Time Zone Database in its concatenated format, and use
/// `TimeZoneDatabase::from_env` when you just want Jiff to try and "do the
/// right thing for you." (`TimeZoneDatabase::from_env` will attempt to
/// automatically detect the presence of a system concatenated `tzdata`
/// file on Android.)
///
/// # Errors
///
/// This returns an error if the given path does not contain a valid
/// copy of the concatenated Time Zone Database.
///
/// [Android Platform]: https://android.googlesource.com/platform/libcore/+/jb-mr2-release/luni/src/main/java/libcore/util/ZoneInfoDB.java
#[cfg(feature = "std")]
pub fn from_concatenated_path<P: AsRef<std::path::Path>>(
path: P,
) -> Result<TimeZoneDatabase, Error> {
let path = path.as_ref();
let db = concatenated::Database::from_path(path)?;
if db.is_definitively_empty() {
warn!(
"could not find concatenated tzdata in file {path}",
path = path.display(),
);
}
Ok(TimeZoneDatabase::new(Kind::Concatenated(db)))
}
/// Returns a time zone database initialized from the bundled copy of
/// the [IANA Time Zone Database].
///
/// While this API is always available, in order to get a non-empty
/// database back, this requires that one of the crate features
/// `tzdb-bundle-always` or `tzdb-bundle-platform` is enabled. In the
/// latter case, the bundled database is only available on platforms known
/// to lack a system copy of the IANA Time Zone Database (i.e., non-Unix
/// systems).
///
/// This routine is infallible, but it may return a database
/// that is definitively empty if the bundled data is not
/// available. To query whether the data is empty or not, use
/// [`TimeZoneDatabase::is_definitively_empty`].
///
/// [IANA Time Zone Database]: https://en.wikipedia.org/wiki/Tz_database
pub fn bundled() -> TimeZoneDatabase {
let db = bundled::Database::new();
if db.is_definitively_empty() {
warn!("could not find embedded/bundled zoneinfo");
}
TimeZoneDatabase::new(Kind::Bundled(db))
}
/// Creates a new DB from the internal kind.
fn new(kind: Kind) -> TimeZoneDatabase {
TimeZoneDatabase { inner: Some(Arc::new(kind)) }
}
/// Returns a [`TimeZone`] corresponding to the IANA time zone identifier
/// given.
///
/// The lookup is performed without regard to ASCII case.
///
/// To see a list of all available time zone identifiers for this database,
/// use [`TimeZoneDatabase::available`].
///
/// # Example
///
/// ```
/// use jiff::tz;
///
/// let tz = tz::db().get("america/NEW_YORK")?;
/// assert_eq!(tz.iana_name(), Some("America/New_York"));
///
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn get(&self, name: &str) -> Result<TimeZone, Error> {
let inner = self.inner.as_deref().ok_or_else(|| {
if cfg!(feature = "std") {
err!(
"failed to find time zone `{name}` since there is no \
time zone database configured",
)
} else {
err!(
"failed to find time zone `{name}`, there is no \
global time zone database configured (and is currently \
impossible to do so without Jiff's `std` feature \
enabled, if you need this functionality, please file \
an issue on Jiff's tracker with your use case)",
)
}
})?;
match *inner {
Kind::ZoneInfo(ref db) => {
if let Some(tz) = db.get(name) {
trace!("found time zone `{name}` in {db:?}", db = self);
return Ok(tz);
}
}
Kind::Concatenated(ref db) => {
if let Some(tz) = db.get(name) {
trace!("found time zone `{name}` in {db:?}", db = self);
return Ok(tz);
}
}
Kind::Bundled(ref db) => {
if let Some(tz) = db.get(name) {
trace!("found time zone `{name}` in {db:?}", db = self);
return Ok(tz);
}
}
}
Err(err!("failed to find time zone `{name}` in time zone database"))
}
/// Returns a list of all available time zone identifiers from this
/// database.
///
/// Note that time zone identifiers are more of a machine readable
/// abstraction and not an end user level abstraction. Still, users
/// comfortable with configuring their system's default time zone through
/// IANA time zone identifiers are probably comfortable interacting with
/// the identifiers returned here.
///
/// # Example
///
/// ```no_run
/// use jiff::tz;
///
/// for tzid in tz::db().available() {
/// println!("{tzid}");
/// }
/// ```
pub fn available<'d>(&'d self) -> TimeZoneNameIter<'d> {
let Some(inner) = self.inner.as_deref() else {
return TimeZoneNameIter::empty();
};
match *inner {
Kind::ZoneInfo(ref db) => db.available(),
Kind::Concatenated(ref db) => db.available(),
Kind::Bundled(ref db) => db.available(),
}
}
/// Resets the internal cache of this database.
///
/// Subsequent interactions with this database will need to re-read time
/// zone data from disk.
///
/// It might be useful to call this if you know the time zone database
/// has changed on disk and want to force Jiff to re-load it immediately
/// without spawning a new process or waiting for Jiff's internal cache
/// invalidation heuristics to kick in.
pub fn reset(&self) {
let Some(inner) = self.inner.as_deref() else { return };
match *inner {
Kind::ZoneInfo(ref db) => db.reset(),
Kind::Concatenated(ref db) => db.reset(),
Kind::Bundled(ref db) => db.reset(),
}
}
/// Returns true if it is known that this time zone database is empty.
///
/// When this returns true, it is guaranteed that all
/// [`TimeZoneDatabase::get`] calls will fail, and that
/// [`TimeZoneDatabase::available`] will always return an empty iterator.
///
/// Note that if this returns false, it is still possible for this database
/// to be empty.
///
/// # Example
///
/// ```
/// use jiff::tz::TimeZoneDatabase;
///
/// let db = TimeZoneDatabase::none();
/// assert!(db.is_definitively_empty());
/// ```
pub fn is_definitively_empty(&self) -> bool {
let Some(inner) = self.inner.as_deref() else { return true };
match *inner {
Kind::ZoneInfo(ref db) => db.is_definitively_empty(),
Kind::Concatenated(ref db) => db.is_definitively_empty(),
Kind::Bundled(ref db) => db.is_definitively_empty(),
}
}
}
impl core::fmt::Debug for TimeZoneDatabase {
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
write!(f, "TimeZoneDatabase(")?;
let Some(inner) = self.inner.as_deref() else {
return write!(f, "unavailable)");
};
match *inner {
Kind::ZoneInfo(ref db) => write!(f, "{db:?}")?,
Kind::Concatenated(ref db) => write!(f, "{db:?}")?,
Kind::Bundled(ref db) => write!(f, "{db:?}")?,
}
write!(f, ")")
}
}
/// An iterator over the time zone identifiers in a [`TimeZoneDatabase`].
///
/// This iterator is created by [`TimeZoneDatabase::available`].
///
/// There are no guarantees about the order in which this iterator yields
/// time zone identifiers.
///
/// The lifetime parameter corresponds to the lifetime of the
/// `TimeZoneDatabase` from which this iterator was created.
#[derive(Clone, Debug)]
pub struct TimeZoneNameIter<'d> {
#[cfg(feature = "alloc")]
it: alloc::vec::IntoIter<TimeZoneName<'d>>,
#[cfg(not(feature = "alloc"))]
it: core::iter::Empty<TimeZoneName<'d>>,
}
impl<'d> TimeZoneNameIter<'d> {
/// Creates a time zone name iterator that never yields any elements.
fn empty() -> TimeZoneNameIter<'d> {
#[cfg(feature = "alloc")]
{
TimeZoneNameIter { it: alloc::vec::Vec::new().into_iter() }
}
#[cfg(not(feature = "alloc"))]
{
TimeZoneNameIter { it: core::iter::empty() }
}
}
/// Creates a time zone name iterator that yields the elements from the
/// iterator given. (They are collected into a `Vec`.)
#[cfg(feature = "alloc")]
fn from_iter(
it: impl Iterator<Item = impl Into<alloc::string::String>>,
) -> TimeZoneNameIter<'d> {
let names: alloc::vec::Vec<TimeZoneName<'d>> =
it.map(|name| TimeZoneName::new(name.into())).collect();
TimeZoneNameIter { it: names.into_iter() }
}
}
impl<'d> Iterator for TimeZoneNameIter<'d> {
type Item = TimeZoneName<'d>;
fn next(&mut self) -> Option<TimeZoneName<'d>> {
self.it.next()
}
}
/// A name for a time zone yield by the [`TimeZoneNameIter`] iterator.
///
/// The iterator is created by [`TimeZoneDatabase::available`].
///
/// The lifetime parameter corresponds to the lifetime of the
/// `TimeZoneDatabase` from which this name was created.
#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
pub struct TimeZoneName<'d> {
/// The lifetime of the tzdb.
///
/// We don't currently use this, but it could be quite useful if we ever
/// adopt a "compile time" tzdb like what `chrono-tz` has. Then we could
/// return strings directly from the embedded data. Or perhaps a "compile
/// time" TZif or some such.
lifetime: core::marker::PhantomData<&'d str>,
#[cfg(feature = "alloc")]
name: alloc::string::String,
#[cfg(not(feature = "alloc"))]
name: core::convert::Infallible,
}
impl<'d> TimeZoneName<'d> {
/// Returns a new time zone name from the string given.
///
/// The lifetime returned is inferred according to the caller's context.
#[cfg(feature = "alloc")]
fn new(name: alloc::string::String) -> TimeZoneName<'d> {
TimeZoneName { lifetime: core::marker::PhantomData, name }
}
/// Returns this time zone name as a borrowed string.
///
/// Note that the lifetime of the string returned is tied to `self`,
/// which may be shorter than the lifetime `'d` of the originating
/// `TimeZoneDatabase`.
#[inline]
pub fn as_str<'a>(&'a self) -> &'a str {
#[cfg(feature = "alloc")]
{
self.name.as_str()
}
#[cfg(not(feature = "alloc"))]
{
// Can never be reached because `TimeZoneName` cannot currently
// be constructed in core-only environments.
unreachable!()
}
}
}
impl<'d> core::fmt::Display for TimeZoneName<'d> {
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
write!(f, "{}", self.as_str())
}
}
#[cfg(test)]
mod tests {
use super::*;
/// This tests that the size of a time zone database is kept at a single
/// word.
///
/// I think it would probably be okay to make this bigger if we had a
/// good reason to, but it seems sensible to put a road-block to avoid
/// accidentally increasing its size.
#[test]
fn time_zone_database_size() {
#[cfg(feature = "alloc")]
{
let word = core::mem::size_of::<usize>();
assert_eq!(word, core::mem::size_of::<TimeZoneDatabase>());
}
// A `TimeZoneDatabase` in core-only is vapid.
#[cfg(not(feature = "alloc"))]
{
assert_eq!(1, core::mem::size_of::<TimeZoneDatabase>());
}
}
}