[−][src]Struct unic_locale::Locale
Locale
is a core struct representing a Unicode Locale Identifier.
A locale is made of two parts:
id
- Unicode Language Identifierextensions
- A set of Unicode Extensions
Locale
exposes all of the same methods as LanguageIdentifier
, and
on top of that is able to parse, manipulate and serialize unicode extension
fields.
Examples
use unic_locale_impl::Locale; let loc: Locale = "en-US-u-ca-buddhist".parse() .expect("Failed to parse."); assert_eq!(loc.id.language, "en"); assert_eq!(loc.id.script, None); assert_eq!(loc.id.region, Some("US".parse().unwrap())); assert_eq!(loc.id.variants().len(), 0); assert_eq!(loc.extensions.unicode.keyword("ca") .expect("Getting keyword failed.") .collect::<Vec<_>>(), &["buddhist"]);
Parsing
Unicode recognizes three levels of standard conformance for a locale:
- well-formed - syntactically correct
- valid - well-formed and only uses registered language subtags, extensions, keywords, types...
- canonical - valid and no deprecated codes or structure.
At the moment parsing normalizes a well-formed language identifier converting
_
separators to -
and adjusting casing to conform to the Unicode standard.
Any bogus subtags will cause the parsing to fail with an error. No subtag validation is performed.
Examples:
use unic_locale_impl::Locale; let loc: Locale = "eN_latn_Us-Valencia_u-hC-H12".parse() .expect("Failed to parse."); assert_eq!(loc.id.language, "en"); assert_eq!(loc.id.script, Some("Latn".parse().unwrap())); assert_eq!(loc.id.region, Some("US".parse().unwrap())); assert_eq!(loc.id.variants().collect::<Vec<_>>(), &["valencia"]);
Fields
id: LanguageIdentifier
extensions: ExtensionsMap
Methods
impl Locale
[src]
pub fn from_bytes(v: &[u8]) -> Result<Locale, LocaleError>
[src]
A constructor which takes a utf8 slice, parses it and
produces a well-formed Locale
.
Examples
use unic_locale_impl::Locale; let loc = Locale::from_bytes("en-US-u-hc-h12".as_bytes()) .expect("Parsing failed."); assert_eq!(loc.to_string(), "en-US-u-hc-h12");
pub fn from_parts(
language: Language,
script: Option<Script>,
region: Option<Region>,
variants: &[Variant],
extensions: Option<ExtensionsMap>
) -> Locale
[src]
language: Language,
script: Option<Script>,
region: Option<Region>,
variants: &[Variant],
extensions: Option<ExtensionsMap>
) -> Locale
A constructor which takes optional subtags as AsRef<[u8]>
, parses them and
produces a well-formed Locale
.
Examples
use unic_locale_impl::Locale; let loc = Locale::from_parts("fr".parse().unwrap(), None, Some("CA".parse().unwrap()), &[], None); assert_eq!(loc.to_string(), "fr-CA");
pub const unsafe fn from_raw_parts_unchecked(
language: Language,
script: Option<Script>,
region: Option<Region>,
variants: Option<Box<[Variant]>>,
extensions: ExtensionsMap
) -> Locale
[src]
language: Language,
script: Option<Script>,
region: Option<Region>,
variants: Option<Box<[Variant]>>,
extensions: ExtensionsMap
) -> Locale
Safety
This function accepts subtags expecting variants to be deduplicated and ordered.
pub fn into_parts(
self
) -> (Language, Option<Script>, Option<Region>, Vec<Variant>, String)
[src]
self
) -> (Language, Option<Script>, Option<Region>, Vec<Variant>, String)
Consumes Locale
and produces raw internal representations
of all subtags in form of u64
/u32
.
Primarily used for storing internal representation and restoring via
from_raw_parts_unchecked
.
Examples
use unic_locale_impl::Locale; use tinystr::{TinyStr8, TinyStr4}; let loc: Locale = "en-US".parse() .expect("Parsing failed."); let (lang, script, region, variants, extensions) = loc.into_parts(); let loc2 = Locale::from_parts( lang, script, region, &variants, Some(extensions.parse().unwrap()) ); assert_eq!(loc2.to_string(), "en-US");
pub fn matches<O>(
&self,
other: &O,
self_as_range: bool,
other_as_range: bool
) -> bool where
O: AsRef<Locale>,
[src]
&self,
other: &O,
self_as_range: bool,
other_as_range: bool
) -> bool where
O: AsRef<Locale>,
Compares a Locale
to another AsRef<Locale
allowing for either side to use the missing fields as wildcards.
This allows for matching between en
(treated as en-*-*-*
) and en-US
.
Examples
use unic_locale_impl::Locale; let loc1: Locale = "en".parse() .expect("Parsing failed."); let loc2: Locale = "en-US".parse() .expect("Parsing failed."); assert_ne!(loc1, loc2); // "en" != "en-US" assert_ne!(loc1.to_string(), loc2.to_string()); // "en" != "en-US" assert_eq!(loc1.matches(&loc2, false, false), false); // "en" != "en-US" assert_eq!(loc1.matches(&loc2, true, false), true); // "en-*-*-*" == "en-US" assert_eq!(loc1.matches(&loc2, false, true), false); // "en" != "en-*-US-*" assert_eq!(loc1.matches(&loc2, true, true), true); // "en-*-*-*" == "en-*-US-*"
Trait Implementations
impl AsRef<LanguageIdentifier> for Locale
[src]
fn as_ref(&self) -> &LanguageIdentifier
[src]
impl AsRef<Locale> for Locale
[src]
impl Clone for Locale
[src]
impl Debug for Locale
[src]
impl Default for Locale
[src]
impl Display for Locale
[src]
impl Eq for Locale
[src]
impl From<LanguageIdentifier> for Locale
[src]
fn from(id: LanguageIdentifier) -> Locale
[src]
impl FromStr for Locale
[src]
type Err = LocaleError
The associated error which can be returned from parsing.
fn from_str(source: &str) -> Result<Locale, <Locale as FromStr>::Err>
[src]
impl Hash for Locale
[src]
fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
[src]
__H: Hasher,
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Into<LanguageIdentifier> for Locale
[src]
fn into(self) -> LanguageIdentifier
[src]
impl Ord for Locale
[src]
fn cmp(&self, other: &Locale) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl PartialEq<Locale> for Locale
[src]
impl PartialOrd<Locale> for Locale
[src]
fn partial_cmp(&self, other: &Locale) -> Option<Ordering>
[src]
fn lt(&self, other: &Locale) -> bool
[src]
fn le(&self, other: &Locale) -> bool
[src]
fn gt(&self, other: &Locale) -> bool
[src]
fn ge(&self, other: &Locale) -> bool
[src]
impl StructuralEq for Locale
[src]
impl StructuralPartialEq for Locale
[src]
Auto Trait Implementations
impl RefUnwindSafe for Locale
impl Send for Locale
impl Sync for Locale
impl Unpin for Locale
impl UnwindSafe for Locale
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,