Struct icu::locale::extensions::unicode::Unicode

pub struct Unicode {
    pub keywords: Keywords,
    pub attributes: Attributes,
}

Unicode Extensions provide information about user preferences in a given locale.

A list of Unicode BCP47 U Extensions as defined in Unicode Locale Identifier specification.

Unicode extensions provide subtags that specify language and/or locale-based behavior or refinements to language tags, according to work done by the Unicode Consortium. (See RFC 6067 for details).

Examples

use icu::locale::extensions::unicode::{key, value};
use icu::locale::Locale;

let loc: Locale =
    "de-u-hc-h12-ca-buddhist".parse().expect("Parsing failed.");

assert_eq!(
    loc.extensions.unicode.keywords.get(&key!("ca")),
    Some(&value!("buddhist"))
);

Fields

keywords: Keywords

The key-value pairs present in this locale extension, with each extension key subtag associated to its provided value subtag.

attributes: Attributes

A canonically ordered sequence of single standalone subtags for this locale extension.

Implementations

impl Unicode

pub const fn new() -> Unicode

Returns a new empty map of Unicode extensions. Same as default(), but is const.

Examples

use icu::locale::extensions::unicode::Unicode;

assert_eq!(Unicode::new(), Unicode::default());

pub fn try_from_str(s: &str) -> Result<Unicode, ParseError>

A constructor which takes a str slice, parses it and produces a well-formed Unicode.

pub fn try_from_utf8(code_units: &[u8]) -> Result<Unicode, ParseError>

See Self::try_from_str

pub fn is_empty(&self) -> bool

Returns true if there list of keywords and attributes is empty.

Examples

use icu::locale::Locale;

let loc: Locale = "en-US-u-foo".parse().expect("Parsing failed.");

assert!(!loc.extensions.unicode.is_empty());

pub fn clear(&mut self)

Clears all Unicode extension keywords and attributes, effectively removing the Unicode extension.

Example

use icu::locale::Locale;

let mut loc: Locale =
    "und-t-mul-u-hello-ca-buddhist-hc-h12".parse().unwrap();
loc.extensions.unicode.clear();
assert_eq!(loc, "und-t-mul".parse().unwrap());

pub fn total_cmp(&self, other: &Unicode) -> Ordering

Returns an ordering suitable for use in BTreeSet.

The ordering may or may not be equivalent to string ordering, and it may or may not be stable across ICU4X releases.

impl Unicode

pub fn to_string(&self) -> String

Converts the given value to a String.

Under the hood, this uses an efficient [Writeable] implementation. However, in order to avoid allocating a string, it is more efficient to use [Writeable] directly.

Trait Implementations

impl Clone for Unicode

fn clone(&self) -> Unicode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Unicode

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Unicode

fn default() -> Unicode

Returns the “default value” for a type.

impl Display for Unicode

This trait is implemented for compatibility with fmt!. To create a string, [Writeable::write_to_string] is usually more efficient.

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl FromStr for Unicode

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Unicode, <Unicode as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Unicode

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Unicode

fn eq(&self, other: &Unicode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Writeable for Unicode

fn write_to<W>(&self, sink: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

Writes a string to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to_parts, and discards any Part annotations.

fn writeable_length_hint(&self) -> LengthHint

Returns a hint for the number of UTF-8 bytes that will be written to the sink.

fn write_to_parts<S>(&self, sink: &mut S) -> Result<(), Error>

where S: PartsWrite + ?Sized,

Write bytes and Part annotations to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to, and doesn’t produce any Part annotations.

fn write_to_string(&self) -> Cow<'_, str>

Creates a new String with the data from this Writeable. Like ToString, but smaller and faster.

impl Eq for Unicode

impl StructuralPartialEq for Unicode