Struct fluent_locale::locale::Locale

pub struct Locale { /* fields omitted */ }

A Locale object.

Locale object stores information encoded in a language tag and provides methods allowing for parsing, serializing and manipulating locale fields.

All data is validated and canonicalized on input, which means that the output is always canonicalized.

Currently supported subtags are:

• language (e.g. "en")
• script (e.g. "Latn")
• region (e.g. "US")
• variants (e.g. "windows")
• extensions (e.g. "-u-ca-gregorian-hc-h12")

The API parses correctly the remaining fields of the BCP47 language tag, but at the moment does not provide any API for operating on them.

Examples

Parsing

Locale supports a From trait from String and &str:

use fluent_locale::Locale;

let loc = Locale::from("en-latn-us");

assert_eq!(loc.to_string(), "en-Latn-US");

Locale can also accept options, similarly to ECMA402 Intl.Locale:

use fluent_locale::Locale;
use std::collections::BTreeMap;

let mut opts = BTreeMap::new();
opts.insert("hour-cycle", "h12");
let loc = Locale::new("en", Some(opts)).unwrap();

assert_eq!(loc.to_string(), "en-u-hc-h12");

Serializing

Locale supports Display trait allowing for:

use fluent_locale::Locale;
use std::collections::BTreeMap;

let mut opts = BTreeMap::new();
opts.insert("hour-cycle", "h12");
let loc = Locale::new("en-Latn-US-u-hc-h23", Some(opts)).unwrap();

assert_eq!(loc.to_string(), "en-Latn-US-u-hc-h12");

Manipulating

During the lifetime of Locale, its fields can be modified via getter/setter methods:

use fluent_locale::Locale;

let mut loc = Locale::from("en-Latn-US");
loc.set_region("GB").unwrap();

assert_eq!(loc.to_string(), "en-Latn-GB");

Methods

impl Locale

fn new(
    loc_str: &str,
    opts: Option<BTreeMap<&str, &str>>
) -> Result<Locale, Error>

fn set_language(&mut self, value: &str) -> Result<(), Error>

fn get_language(&self) -> &str

fn set_script(&mut self, value: &str) -> Result<(), Error>

fn get_script(&self) -> &str

fn set_region(&mut self, value: &str) -> Result<(), Error>

fn get_region(&self) -> &str

fn add_variant(&mut self, value: String)

fn remove_variant(&mut self, value: String)

fn get_variants(&self) -> Vec<&String>

fn clear_variants(&mut self)

fn get_extensions(&self) -> BTreeMap<String, &BTreeMap<String, String>>

fn add_extension(&mut self, ext_name: String, key: String, value: String)

fn matches(
    &self,
    other: &Locale,
    available_range: bool,
    requested_range: bool
) -> bool

Trait Implementations

impl Debug for Locale

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Locale

fn default() -> Locale

Returns the "default value" for a type.

impl PartialEq for Locale

fn eq(&self, __arg_0: &Locale) -> bool

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

fn ne(&self, __arg_0: &Locale) -> bool

This method tests for !=.

impl Clone for Locale

fn clone(&self) -> Locale

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<String> for Locale

fn from(s: String) -> Self

Performs the conversion.

impl<'a> From<&'a str> for Locale

fn from(s: &'a str) -> Self

Performs the conversion.

impl Display for Locale

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

Formats the value using the given formatter.