Struct Locale 

pub struct Locale { /* private fields */ }

A language, and optionally the script and the country it is written in (locale.dart).

The language is required and the other two are not, which is the reference’s shape and the useful one: fr is an answer, fr-CA is a better one, and zh-Hant-TW needs all three to be right.

Comparison is exact — fr is not fr-CA. Deciding that one of them will do for the other is resolve’s work, and it takes the whole list to do it.

Implementations

impl Locale

pub fn new(language: impl Into<String>) -> Locale

A language on its own: Locale::new("fr").

pub fn with_country( language: impl Into<String>, country: impl Into<String>, ) -> Locale

A language in a country: Locale::with_country("fr", "CA").

pub fn script(self, script: impl Into<String>) -> Locale

Adds a script (Hant, Latn): the writing system, which for some languages is the question that decides legibility rather than idiom.

pub fn country(self, country: impl Into<String>) -> Locale

Adds a country (CA, BR).

pub fn language_code(&self) -> &str

The language subtag, lowercase. Always present.

pub fn script_code(&self) -> Option<&str>

The script subtag, title case, if there is one.

pub fn country_code(&self) -> Option<&str>

The country subtag, uppercase, if there is one.

pub fn parse(tag: &str) -> Option<Locale>

Reads a language tag: fr, fr-CA, fr_CA, zh-Hant-TW, en-US.UTF-8, pt_BR@euro.

Both separators, because both arrive: a language tag uses - and a POSIX environment variable uses _. The encoding and modifier suffixes a Unix LANG carries are dropped — en_US.UTF-8 is the en-US locale in a particular byte encoding, and the encoding is not part of which language this is.

A subtag is read by shape, as BCP 47 does: four letters is a script, two letters or three digits is a region. That is what lets zh-Hant and zh-TW both be understood without a table of every code.

Returns None for a tag with no language in it at all, including the C and POSIX locales, which name an absence of one.

Trait Implementations

impl Clone for Locale

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Locale

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

Formats the value using the given formatter.

impl Default for Locale

fn default() -> Locale

en, which is what every string the framework says was written in before any of them could be translated.

impl Display for Locale

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

The language tag, hyphenated: fr, fr-CA, zh-Hant-TW. What Locale::parse reads back.

impl Eq for Locale

impl FromStr for Locale

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Locale, ()>

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

impl Hash for Locale

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Locale

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Locale

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Locale

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Locale