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
// 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 ). //! `icu` is the main meta-package of the `ICU4X` project. //! //! It provides a comprehensive selection of //! [Unicode Internationalization Components](http://site.icu-project.org/) //! in their canonical configurations intended to enable software //! internationalization capabilities. //! //! The package is provided for convenience and users are encouraged //! to fine-tune components with the features they need. //! //! The package does not bring any unique functionality. Users //! can achieve the exact same by manually including the dependent //! components with pre-selected features. //! //! # Data Management //! //! Most of Unicode functionality relies on data which has to be provided //! to the APIs. //! //! `ICU4X` project uses a concept of [`DataProvider`] - a service used to //! handle data management. //! //! There can be many different heuristics for handling data management and //! this meta-package does not supply any default [`DataProvider`]. //! //! When using `ICU4X` users are expected to decide which provider they want to use //! and instrument it to point at the correct location where the data files are stored. //! //! In the following examples an [`icu_testdata`] package is used which wraps //! an [`FsDataProvider`] with locally available subset of data. //! //! # Features //! //! ICU4X components share a set of common features that control whether core pieces of //! functionality are compiled. These features are: //! //! - `provider_serde`: Whether to include Serde Serialize/Deserialize implementations for //! ICU4X locale data structs, such as [`SymbolsV1`]. (On by default) //! - `serde`: Whether to include Serde Serialize/Deserialize implementations for core libary //! types, such as [`Locale`]. //! - `bench`: Whether to enable exhaustive benchmarks. This can be enabled on individual crates //! when running `cargo bench`. //! - `experimental`: Whether to enable experimental preview features. Modules enabled with //! this feature may not be production-ready and could change at any time. //! - `provider_transform_internals`: This is code that is useful for transforming CLDR data, but //! may be risky to ship as a public API. For instance in DateTimeFormat code we may want to //! manipulate patterns, but not allow end users to do the same. //! //! # Example //! //! ``` //! use icu::locid::Locale; //! use icu::locid::macros::langid; //! use icu::datetime::{DateTimeFormat, mock::datetime::MockDateTime, options::length}; //! //! let provider = icu_testdata::get_provider(); //! //! let locale: Locale = langid!("en").into(); //! //! let options = length::Bag { //! date: Some(length::Date::Long), //! time: Some(length::Time::Medium), //! ..Default::default() //! }.into(); //! //! let dtf = DateTimeFormat::try_new(locale, &provider, &options) //! .expect("Failed to create DateTimeFormat instance."); //! //! let date: MockDateTime = "2020-09-12T12:35:00".parse() //! .expect("Failed to parse date."); //! //! let formatted_date = dtf.format(&date); //! assert_eq!(formatted_date.to_string(), "September 12, 2020 at 12:35:00 PM"); //! ``` //! //! [`DataProvider`]: ../icu_provider/prelude/trait.DataProvider.html //! [`FsDataProvider`]: ../icu_provider_fs/struct.FsDataProvider.html //! [`icu_testdata`]: ../icu_testdata/index.html //! [`Locale`]: crate::locid::Locale //! [`SymbolsV1`]: crate::decimal::provider::DecimalSymbolsV1 #![cfg_attr(not(any(test, feature = "std")), no_std)] pub mod datetime { //! Date and Time operations //! //! This API provides necessary functionality for formatting date and time to user readable textual representation. //! //! [`DateTimeFormat`] is the main structure of the component. It accepts a set of arguments which //! allow it to collect necessary data from the [`DataProvider`], and once instantiated, can be //! used to quickly format any date and time provided. //! //! # Examples //! //! ``` //! use icu::locid::Locale; //! use icu::locid::macros::langid; //! use icu::datetime::{DateTimeFormat, mock::datetime::MockDateTime, options::length}; //! //! let provider = icu_testdata::get_provider(); //! //! let locale: Locale = langid!("en").into(); //! //! let options = length::Bag { //! date: Some(length::Date::Medium), //! time: Some(length::Time::Short), //! ..Default::default() //! }.into(); //! //! let dtf = DateTimeFormat::try_new(locale, &provider, &options) //! .expect("Failed to create DateTimeFormat instance."); //! //! let date: MockDateTime = "2020-09-12T12:35:00".parse() //! .expect("Failed to parse date."); //! //! let formatted_date = dtf.format(&date); //! assert_eq!(formatted_date.to_string(), "Sep 12, 2020, 12:35 PM"); //! ``` //! [`DataProvider`]: ../../icu_provider/index.html pub use icu_datetime::*; } pub mod decimal { //! Decimal formatting operations //! //! This API provides necessary functionality for formatting of numbers with decimal digits. //! //! [`FixedDecimalFormat`] is the main structure of the component. It formats a //! [`FixedDecimal`] to a [`FormattedFixedDecimal`]. //! //! # Examples //! //! ## Format a number with Bengali digits //! //! ``` //! use icu::decimal::FixedDecimalFormat; //! use icu::locid::Locale; //! use icu::locid::macros::langid; //! use writeable::Writeable; //! //! let locale: Locale = langid!("bn").into(); //! let provider = icu_testdata::get_provider(); //! let fdf = FixedDecimalFormat::try_new(locale, &provider, Default::default()) //! .expect("Data should load successfully"); //! //! let fixed_decimal = 1000007.into(); //! let formatted_value = fdf.format(&fixed_decimal); //! let formatted_str = formatted_value.writeable_to_string(); //! //! assert_eq!("১০,০০,০০৭", formatted_str); //! ``` //! //! ## Format a number with digits after the decimal separator //! //! ``` //! use fixed_decimal::FixedDecimal; //! use icu::decimal::FixedDecimalFormat; //! use icu::locid::Locale; //! use writeable::Writeable; //! //! let locale = Locale::und(); //! let provider = icu_provider::inv::InvariantDataProvider; //! let fdf = FixedDecimalFormat::try_new(locale, &provider, Default::default()) //! .expect("Data should load successfully"); //! //! let fixed_decimal = FixedDecimal::from(200050) //! .multiplied_pow10(-2) //! .expect("Operation is fully in range"); //! //! assert_eq!("2,000.50", fdf.format(&fixed_decimal).writeable_to_string()); //! ``` //! //! [`FixedDecimal`]: fixed_decimal::FixedDecimal pub use icu_decimal::*; } pub mod locale_canonicalizer { //! This API provides functionality to canonicalize locale identifiers based //! upon [`CLDR`] data. //! //! It currently supports the minimize and maximize likely subtags algorithms //! as described in [`UTS #35: Unicode LDML 3. Likely Subtags`]. //! //! # Examples //! //! ``` //! use icu_locale_canonicalizer::{CanonicalizationResult, LocaleCanonicalizer}; //! use icu_locid::Locale; //! //! let provider = icu_testdata::get_provider(); //! let lc = LocaleCanonicalizer::new(&provider) //! .expect("create failed"); //! //! let mut locale : Locale = "zh-CN".parse() //! .expect("parse failed"); //! assert_eq!(lc.maximize(&mut locale), CanonicalizationResult::Modified); //! assert_eq!(locale.to_string(), "zh-Hans-CN"); //! //! let mut locale : Locale = "zh-Hant-TW".parse() //! .expect("parse failed"); //! assert_eq!(lc.maximize(&mut locale), CanonicalizationResult::Unmodified); //! assert_eq!(locale.to_string(), "zh-Hant-TW"); //! ``` //! //! ``` //! use icu_locale_canonicalizer::{CanonicalizationResult, LocaleCanonicalizer}; //! use icu_locid::Locale; //! //! let provider = icu_testdata::get_provider(); //! let lc = LocaleCanonicalizer::new(&provider) //! .expect("create failed"); //! //! let mut locale : Locale = "zh-Hans-CN".parse() //! .expect("parse failed"); //! assert_eq!(lc.minimize(&mut locale), CanonicalizationResult::Modified); //! assert_eq!(locale.to_string(), "zh"); //! //! let mut locale : Locale = "zh".parse() //! .expect("parse failed"); //! assert_eq!(lc.minimize(&mut locale), CanonicalizationResult::Unmodified); //! assert_eq!(locale.to_string(), "zh"); //! ``` //! [`ICU4X`]: ../icu/index.html //! [`CLDR`]: http://cldr.unicode.org/ //! [`UTS #35: Unicode LDML 3. Likely Subtags`]: https://www.unicode.org/reports/tr35/#Likely_Subtags. pub use icu_locale_canonicalizer::*; } pub mod locid { //! Language and Locale operations //! //! This API provides necessary functionality for parsing, manipulating, and serializing Unicode Language //! and Locale Identifiers. //! //! The crate provides algorithms for parsing a string into a well-formed language or locale identifier //! as defined by [`UTS #35: Unicode LDML 3. Unicode Language and Locale Identifiers`]. //! //! [`Locale`] is the most common structure to use for storing information about a language, //! script, region, variants and extensions. In almost all cases, this struct should be used as the //! base unit for all locale management operations. //! //! [`LanguageIdentifier`] is a strict subset of [`Locale`] which can be useful in a narrow range of //! cases where [`Unicode Extensions`] are not relevant. //! //! If in doubt, use [`Locale`]. //! //! # Examples //! //! ``` //! use icu::locid::Locale; //! use icu::locid::subtags::{Language, Region}; //! //! let mut loc: Locale = "en-US".parse() //! .expect("Parsing failed."); //! //! let lang: Language = "en".parse() //! .expect("Parsing failed."); //! let region: Region = "US".parse() //! .expect("Parsing failed."); //! //! assert_eq!(loc.id.language, lang); //! assert_eq!(loc.id.script, None); //! assert_eq!(loc.id.region, Some(region)); //! assert_eq!(loc.id.variants.len(), 0); //! //! let region: Region = "GB".parse().expect("Parsing failed."); //! loc.id.region = Some(region); //! //! assert_eq!(loc.to_string(), "en-GB"); //! ``` //! //! For more details, see [`Locale`] and [`LanguageIdentifier`]. //! //! [`UTS #35: Unicode LDML 3. Unicode Language and Locale Identifiers`]: https://unicode.org/reports/tr35/tr35.html#Unicode_Language_and_Locale_Identifiers //! [`ICU4X`]: https://github.com/unicode-org/icu4x //! [`Unicode Extensions`]: extensions pub use icu_locid::*; pub mod macros { pub use icu_locid_macros::*; } } pub mod plurals { //! Plural Rules operations //! //! This API provides functionality to determine the plural category //! appropriate for a given number in a given language. //! //! For example in English language, when constructing a message //! such as `{ num } items`, the user has to prepare //! two variants of the message: //! //! * `1 item` //! * `0 items`, `2 items`, `5 items`, `0.5 items` etc. //! //! The former variant is used when the placeholder variable has value `1`, //! while the latter is used for all other values of the variable. //! //! Unicode defines [`Language Plural Rules`] as a mechanism to codify those //! variants and provides data and algorithms to calculate //! appropriate [`Plural Category`]. //! //! # Examples //! //! ``` //! use icu::locid::macros::langid; //! use icu::plurals::{PluralRules, PluralRuleType, PluralCategory}; //! //! let lid = langid!("en"); //! //! let provider = icu_testdata::get_provider(); //! //! let pr = PluralRules::try_new(lid, &provider, PluralRuleType::Cardinal) //! .expect("Failed to construct a PluralRules struct."); //! //! assert_eq!(pr.select(5_usize), PluralCategory::Other); //! ``` //! //! ## Plural Rules //! //! The crate provides the main struct [`PluralRules`] which handles selection //! of the correct [`Plural Category`] for a given language and [`Plural Type`]. //! //! ## Plural Category //! //! Every number in every language belongs to a certain [`Plural Category`]. //! For example, Polish language uses four: //! //! * [`One`](PluralCategory::One): `1 miesiąc` //! * [`Few`](PluralCategory::Few): `2 miesiące` //! * [`Many`](PluralCategory::Many): `5 miesięcy` //! * [`Other`](PluralCategory::Other): `1.5 miesiąca` //! //! ## Plural Rule Type //! //! Plural rules depend on the use case. This crate supports two types of plural rules: //! //! * [`Cardinal`](PluralRuleType::Cardinal): `3 doors`, `1 month`, `10 dollars` //! * [`Ordinal`](PluralRuleType::Ordinal): `1st place`, `10th day`, `11th floor` //! //! [`ICU4X`]: https://github.com/unicode-org/icu4x //! [`Plural Type`]: PluralRuleType //! [`Plural Category`]: PluralCategory //! [`Language Plural Rules`]: https://unicode.org/reports/tr35/tr35-numbers.html#Language_Plural_Rules //! [`CLDR`]: http://cldr.unicode.org/ pub use icu_plurals::*; } pub mod uniset { //! Unicode Set operations //! //! This API provides necessary functionality for highly efficient querying of sets of Unicode characters. //! //! It is an implementation of the existing [ICU4C UnicodeSet API](https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1UnicodeSet.html). //! //! # Architecture //! ICU4X `UnicodeSet` is split up into independent levels, with [`UnicodeSet`] representing the membership/query API, //! and [`UnicodeSetBuilder`] representing the builder API. A [Properties API](http://userguide.icu-project.org/strings/properties) //! is in future works. //! //! # Examples: //! //! ## Creating a `UnicodeSet` //! //! UnicodeSets are created from either serialized UnicodeSets, //! represented by [inversion lists](http://userguide.icu-project.org/strings/properties), //! the [`UnicodeSetBuilder`], or from the TBA Properties API. //! //! ``` //! use icu::uniset::{UnicodeSet, UnicodeSetBuilder}; //! //! let mut builder = UnicodeSetBuilder::new(); //! builder.add_range(&('A'..'Z')); //! let set: UnicodeSet = builder.build(); //! //! assert!(set.contains('A')); //! ``` //! //! ## Querying a `UnicodeSet` //! //! Currently, you can check if a character/range of characters exists in the UnicodeSet, or iterate through the characters. //! //! ``` //! use icu::uniset::{UnicodeSet, UnicodeSetBuilder}; //! //! let mut builder = UnicodeSetBuilder::new(); //! builder.add_range(&('A'..'Z')); //! let set: UnicodeSet = builder.build(); //! //! assert!(set.contains('A')); //! assert!(set.contains_range(&('A'..='C'))); //! assert_eq!(set.iter_chars().next(), Some('A')); //! ``` pub use icu_uniset::*; }