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
// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
#![allow(deprecated)] // all APIS in here are deprecated
use crate::error::TimeZoneError;
use crate::provider::names::*;
use crate::TimeZoneBcp47Id;
use icu_provider::prelude::*;
/// A mapper from IANA time zone identifiers to BCP-47 time zone identifiers.
///
/// # Examples
///
/// ```
/// use icu::timezone::IanaToBcp47Mapper;
///
/// let mapper = IanaToBcp47Mapper::new();
/// let mapper_borrowed = mapper.as_borrowed();
///
/// // The IANA zone "Australia/Melbourne" is the BCP-47 zone "aumel"
/// assert_eq!(
/// mapper_borrowed.get("Australia/Melbourne"),
/// Some("aumel".parse().unwrap())
/// );
///
/// // Lookup is ASCII-case insensitive
/// assert_eq!(
/// mapper_borrowed.get("australia/melbourne"),
/// Some("aumel".parse().unwrap())
/// );
///
/// // The IANA zone "Australia/Victoria" is an alias
/// assert_eq!(
/// mapper_borrowed.get("Australia/Victoria"),
/// Some("aumel".parse().unwrap())
/// );
/// ```
#[derive(Debug)]
#[deprecated(since = "1.5.0", note = "use `TimeZoneIdMapper` instead")]
pub struct IanaToBcp47Mapper {
data: DataPayload<IanaToBcp47MapV1Marker>,
}
#[cfg(feature = "compiled_data")]
impl Default for IanaToBcp47Mapper {
fn default() -> Self {
Self::new()
}
}
impl IanaToBcp47Mapper {
/// Creates a new [`IanaToBcp47Mapper`] using compiled data.
///
/// See [`IanaToBcp47Mapper`] for an example.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
#[inline]
pub const fn new() -> Self {
IanaToBcp47Mapper {
data: DataPayload::from_static_ref(
crate::provider::Baked::SINGLETON_TIME_ZONE_IANA_TO_BCP47_V1,
),
}
}
icu_provider::gen_any_buffer_data_constructors!(locale: skip, options: skip, error: TimeZoneError,
#[cfg(skip)]
functions: [
new,
try_new_with_any_provider,
try_new_with_buffer_provider,
try_new_unstable,
Self,
]
);
#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::new)]
pub fn try_new_unstable<P>(provider: &P) -> Result<Self, TimeZoneError>
where
P: DataProvider<IanaToBcp47MapV1Marker> + ?Sized,
{
let data = provider.load(Default::default())?.take_payload()?;
Ok(Self { data })
}
/// Returns a borrowed version of the mapper that can be queried.
///
/// This avoids a small potential cost of reading the data pointer.
pub fn as_borrowed(&self) -> IanaToBcp47MapperBorrowed {
IanaToBcp47MapperBorrowed {
data: self.data.get(),
}
}
}
/// A borrowed wrapper around IANA-to-BCP47 time zone data, returned by
/// [`IanaToBcp47Mapper::as_borrowed()`]. More efficient to query.
#[derive(Debug)]
#[deprecated(since = "1.5.0", note = "use `TimeZoneIdMapper` instead")]
pub struct IanaToBcp47MapperBorrowed<'a> {
data: &'a IanaToBcp47MapV1<'a>,
}
impl<'a> IanaToBcp47MapperBorrowed<'a> {
/// Looks up a BCP-47 time zone identifier based on an ASCII-case-insensitive match for
/// the given IANA time zone identifier.
///
/// This is the type of match specified in [ECMAScript Temporal].
///
/// See examples in [`IanaToBcp47Mapper`].
///
/// [ECMAScript Temporal]: https://tc39.es/proposal-temporal/#sec-isavailabletimezonename
pub fn get(&self, iana_id: &str) -> Option<TimeZoneBcp47Id> {
self.get_bytes(iana_id.as_bytes())
}
/// Looks up a BCP-47 time zone identifier based on an ASCII-case-insensitive match for
/// the given IANA time zone identifier.
///
/// This is the type of match specified in [ECMAScript Temporal].
///
/// See examples in [`IanaToBcp47Mapper`].
///
/// [ECMAScript Temporal]: https://tc39.es/proposal-temporal/#sec-isavailabletimezonename
pub fn get_bytes(&self, iana_id: &[u8]) -> Option<TimeZoneBcp47Id> {
// The longest IANA name in CLDR appears to be "America/Argentina/ComodRivadavia"
// which is 32 characters long, so 48 should be plenty. Add a debug assertion
// just in case.
let name_for_lookup = match tinystr::TinyAsciiStr::<48>::from_bytes(iana_id) {
Ok(tinystr) => tinystr.to_ascii_lowercase(),
Err(tinystr::TinyStrError::TooLarge { .. }) => {
debug_assert!(false, "IANA string too long for lookup");
return None;
}
Err(_) => {
// NonAscii
return None;
}
};
let idx = self.data.map.get(name_for_lookup.as_bytes())?;
self.data.bcp47_ids.get(idx)
}
}
/// A mapper that supports mapping IANA identifiers to BCP-47 identifiers and also
/// the other way around.
///
/// This is mainly useful if the IANA identifier needs to be recovered or
/// canonicalized.
///
/// # Examples
///
/// Demonstration of canonicalization of the time zone identifier:
///
/// ```
/// use icu::timezone::IanaBcp47RoundTripMapper;
///
/// let mapper = IanaBcp47RoundTripMapper::new();
/// let mapper_borrowed = mapper.as_borrowed();
///
/// // Look up the time zone ID for "Asia/Calcutta"
/// let bcp47_id = mapper_borrowed.iana_to_bcp47("Asia/Calcutta");
/// assert_eq!(bcp47_id, Some("inccu".parse().unwrap()));
///
/// // Get it back as the canonical form "Asia/Kolkata"
/// let iana_id = mapper_borrowed.bcp47_to_iana(bcp47_id.unwrap());
/// assert_eq!(iana_id, Some("Asia/Kolkata"))
/// ```
#[derive(Debug)]
#[deprecated(since = "1.5.0", note = "use `TimeZoneIdMapper` instead")]
pub struct IanaBcp47RoundTripMapper {
data1: DataPayload<IanaToBcp47MapV1Marker>,
data2: DataPayload<Bcp47ToIanaMapV1Marker>,
}
#[cfg(feature = "compiled_data")]
impl Default for IanaBcp47RoundTripMapper {
fn default() -> Self {
Self::new()
}
}
impl IanaBcp47RoundTripMapper {
/// Creates a new [`IanaBcp47RoundTripMapper`] using compiled data.
///
/// See [`IanaBcp47RoundTripMapper`] for an example.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
#[cfg(feature = "compiled_data")]
#[inline]
pub const fn new() -> Self {
const _: () = assert!(
crate::provider::Baked::SINGLETON_TIME_ZONE_IANA_TO_BCP47_V1.bcp47_ids_checksum
== crate::provider::Baked::SINGLETON_TIME_ZONE_BCP47_TO_IANA_V1.bcp47_ids_checksum,
);
IanaBcp47RoundTripMapper {
data1: DataPayload::from_static_ref(
crate::provider::Baked::SINGLETON_TIME_ZONE_IANA_TO_BCP47_V1,
),
data2: DataPayload::from_static_ref(
crate::provider::Baked::SINGLETON_TIME_ZONE_BCP47_TO_IANA_V1,
),
}
}
icu_provider::gen_any_buffer_data_constructors!(locale: skip, options: skip, error: TimeZoneError,
#[cfg(skip)]
functions: [
new,
try_new_with_any_provider,
try_new_with_buffer_provider,
try_new_unstable,
Self,
]
);
#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::new)]
pub fn try_new_unstable<P>(provider: &P) -> Result<Self, TimeZoneError>
where
P: DataProvider<IanaToBcp47MapV1Marker> + DataProvider<Bcp47ToIanaMapV1Marker> + ?Sized,
{
let data1 = provider.load(Default::default())?.take_payload()?;
let data2 = provider.load(Default::default())?.take_payload()?;
let obj = Self { data1, data2 };
if obj.data1.get().bcp47_ids_checksum != obj.data2.get().bcp47_ids_checksum {
return Err(TimeZoneError::MismatchedChecksums);
}
Ok(obj)
}
/// Returns a borrowed version of the mapper that can be queried.
///
/// This avoids a small potential cost of reading the data pointer.
pub fn as_borrowed(&self) -> IanaBcp47RoundTripMapperBorrowed {
IanaBcp47RoundTripMapperBorrowed {
data1: self.data1.get(),
data2: self.data2.get(),
}
}
}
/// A borrowed wrapper around IANA-BCP47 time zone data, returned by
/// [`IanaBcp47RoundTripMapper::as_borrowed()`]. More efficient to query.
#[derive(Debug)]
#[deprecated(since = "1.5.0", note = "use `TimeZoneIdMapper` instead")]
pub struct IanaBcp47RoundTripMapperBorrowed<'a> {
data1: &'a IanaToBcp47MapV1<'a>,
data2: &'a Bcp47ToIanaMapV1<'a>,
}
impl<'a> IanaBcp47RoundTripMapperBorrowed<'a> {
/// Looks up a BCP-47 time zone identifier based on an ASCII-case-insensitive match for
/// the given IANA time zone identifier.
///
/// This is the type of match specified in [ECMAScript Temporal].
///
/// See examples in [`IanaToBcp47Mapper`] or [`IanaBcp47RoundTripMapper`].
///
/// [ECMAScript Temporal]: https://tc39.es/proposal-temporal/#sec-isavailabletimezonename
pub fn iana_to_bcp47(&self, iana_id: &str) -> Option<TimeZoneBcp47Id> {
IanaToBcp47MapperBorrowed { data: self.data1 }.get(iana_id)
}
/// Looks up the canonical IANA time zone identifier of a BCP-47
/// time zone identifier.
///
/// See examples in [`IanaBcp47RoundTripMapper`].
pub fn bcp47_to_iana(&self, bcp47_id: TimeZoneBcp47Id) -> Option<&str> {
let index = self.data1.bcp47_ids.binary_search(&bcp47_id).ok()?;
self.data2.canonical_iana_ids.get(index)
}
}