Struct rust_icu_uloc::ULoc

pub struct ULoc { /* fields omitted */ }

A representation of a Unicode locale.

For the time being, only basic conversion and methods are in fact implemented.

To get basic validation when creating a locale, use for_language_tag with a Unicode BCP-47 locale ID.

Implementations

impl ULoc

pub fn language(&self) -> Option<String>

Implements uloc_getLanguage.

pub fn script(&self) -> Option<String>

Implements uloc_getScript.

pub fn country(&self) -> Option<String>

Implements uloc_getCountry.

pub fn variant(&self) -> Option<String>

Implements uloc_getVariant.

pub fn canonicalize(&self) -> Result<ULoc, Error>

Implements uloc_canonicalize from ICU4C.

pub fn add_likely_subtags(&self) -> Result<ULoc, Error>

Implements uloc_addLikelySubtags from ICU4C.

pub fn minimize_subtags(&self) -> Result<ULoc, Error>

Implements uloc_minimizeSubtags from ICU4C.

pub fn to_language_tag(&self, strict: bool) -> Result<String, Error>

Implements uloc_toLanguageTag from ICU4C.

pub fn keywords(&self) -> impl Iterator<Item = String>

Implements uloc_openKeywords() from ICU4C.

pub fn unicode_keywords(&self) -> impl Iterator<Item = String>

Implements icu::Locale::getUnicodeKeywords() from the C++ API.

pub fn keyword_value(&self, keyword: &str) -> Result<Option<String>, Error>

Implements uloc_getKeywordValue() from ICU4C.

pub fn unicode_keyword_value(
    &self,
    unicode_keyword: &str
) -> Result<Option<String>, Error>

Implements icu::Locale::getUnicodeKeywordValue() from ICU4C.

pub fn label(&self) -> &str

Returns the current label of this locale.

pub fn as_c_str(&self) -> CString

Returns the current locale name as a C string.

pub fn for_language_tag(tag: &str) -> Result<ULoc, Error>

Implements uloc_forLanguageTag from ICU4C.

Note that an invalid tag will cause that tag and all others to be ignored. For example en-us will work but en_US will not.

pub fn base_name(self) -> Self

Implements uloc_getBaseName from ICU4C.

Trait Implementations

impl Clone for ULoc

fn clone(&self) -> ULoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ULoc

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

Formats the value using the given formatter.

impl Display for ULoc

Implement the Display trait to convert the ULoc into string for display.

The string for display and string serialization happen to be the same for ULoc.

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

Formats the value using the given formatter.

impl From<ULoc> for ULocMut

fn from(l: ULoc) -> Self

Turns ULoc into ULocMut, which can be mutated.

impl From<ULocMut> for ULoc

fn from(lm: ULocMut) -> Self

Performs the conversion.

impl Hash for ULoc

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for ULoc

This implementation is based on ULocale.compareTo from ICU4J. See https://github.com/unicode-org/icu/blob/%6d%61%73%74%65%72/icu4j/main/classes/core/src/com/ibm/icu/util/ULocale.java

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ULoc> for ULoc

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ULoc> for ULoc

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&'_ CStr> for ULoc

fn try_from(s: &CStr) -> Result<Self, Self::Error>

Creates a new ULoc from a borrowed C string.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<&'_ str> for ULoc

fn try_from(s: &str) -> Result<Self, Self::Error>

Creates a new ULoc from a string slice.

The creation wil fail if the locale is nonexistent.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for ULoc

impl StructuralEq for ULoc

impl StructuralPartialEq for ULoc