Struct num_format::SystemLocale

pub struct SystemLocale { /* fields omitted */ }

A key type. Represents formats obtained from your operating system. Implements Format.

Example

use num_format::SystemLocale;

fn main() {
    let locale = SystemLocale::default().unwrap();
    println!("My system's default locale is...");
    println!("{:#?}", &locale);

    let available = SystemLocale::available_names().unwrap();
    println!("My available locale names are...");
    println!("{:#?}", available);

    match SystemLocale::from_name("en_US") {
        Ok(_) => println!("My system has the 'en_US' locale."),
        Err(_) => println!("The 'en_US' locale is not included with my system."),
    }
}

Methods

impl SystemLocale

pub fn new() -> Result<SystemLocale, Error>

Same as default.

pub fn default() -> Result<SystemLocale, Error>

Constucts a SystemLocale based on your operating system's default locale.

• Unix-based systems (including macOS): The default locale is controlled by "locale category environment variables," such as LANG, LC_MONETARY, LC_NUMERIC, and LC_ALL. For more information, see here.
• Windows: The default locale is controlled by the regional and language options portion of the Control Panel. For more information, see here.

Errors

Returns an error if the operating system returned something unexpected (such as a null pointer).

pub fn from_name<S>(name: S) -> Result<SystemLocale, Error> where
    S: Into<String>, 

Constucts a SystemLocale from the provided locale name. For a list of locale names available on your system, see available_names.

Errors

Returns an error if the name provided could not be parsed into a SystemLocale or if the operating system returned something unexpected (such as a null pointer).

pub fn available_names() -> Result<HashSet<String>, Error>

Returns a set of the locale names available on your operating system.

• Unix-based systems (including macOS): The underlying implementation uses the locale command.
• Windows: The underlying implementation uses the EnumSystemLocalesEx function.

Errors

Returns an error if the operating system returned something unexpected (such as a null pointer).

pub fn decimal(&self) -> &str

Returns this locale's string representation of a decimal point.

pub fn grouping(&self) -> Grouping

Returns this locale's Grouping, which governs how digits are separated (see Grouping).

pub fn infinity(&self) -> &str

Returns this locale's string representation of infinity.

pub fn minus_sign(&self) -> &str

Returns this locale's string representation of a minus sign.

pub fn name(&self) -> &str

Returns this locale's name.

pub fn nan(&self) -> &str

Returns this locale's string representation of NaN.

pub fn plus_sign(&self) -> &str

Returns this locale's string representation of a plus sign.

pub fn separator(&self) -> &str

Returns this locale's string representation of a thousands separator.

pub fn set_infinity<S>(&mut self, s: S) -> Result<(), Error> where
    S: AsRef<str>, 

Unix-based operating systems (including macOS) do not provide information on how to represent infinity symbols; so num-format uses "∞" (U+221E) as a default. This method allows you to change that default.

Errors

Returns an error the provided string is longer than 128 bytes.

pub fn set_nan<S>(&mut self, s: S) -> Result<(), Error> where
    S: AsRef<str>, 

Unix-based operating systems (including macOS) do not provide information on how to represent NaN; so num-format uses "NaN" as a default. This method allows you to change that default.

Errors

Returns an error the provided string is longer than 64 bytes.

Trait Implementations

impl Format for SystemLocale

fn decimal(&self) -> DecimalStr

Returns the string representation of a decimal point.

fn grouping(&self) -> Grouping

Returns the [Grouping] to use for separating digits. (see [Grouping])

fn infinity(&self) -> InfinityStr

Returns the string representation of an infinity symbol.

fn minus_sign(&self) -> MinusSignStr

Returns the string representation of a minus sign.

fn nan(&self) -> NanStr

Returns the string representation of NaN.

fn plus_sign(&self) -> PlusSignStr

Returns the string representation of a plus sign.

fn separator(&self) -> SeparatorStr

Returns the string representation of a thousands separator.

impl From<SystemLocale> for CustomFormat

fn from(locale: SystemLocale) -> Self

Performs the conversion.

impl From<SystemLocale> for CustomFormatBuilder

fn from(locale: SystemLocale) -> Self

Performs the conversion.

impl Eq for SystemLocale

impl Clone for SystemLocale

fn clone(&self) -> SystemLocale

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<SystemLocale> for SystemLocale

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

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

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

This method tests for !=.

impl Hash for SystemLocale

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 Debug for SystemLocale

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

Formats the value using the given formatter.

impl FromStr for SystemLocale

type Err = Error

The associated error which can be returned from parsing.

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

Same as from_name.