Struct num_format::Environment

pub struct Environment { /* fields omitted */ }

Type for obtaining your system locale from the LC_ALL environment variable. Implements Format.

Example

use std::env;

use num_format::{Environment, Error, ToFormattedString};

fn main() -> Result<(), Error> {
    // Use your system's default locale settings
    let format = Environment::new()?;
    let s = (-1000000).to_formatted_string(&format);
    println!("{}", &s);

    // Use your system's locale settings for "en_US.UTF-8"
    env::set_var("LC_ALL", "en_US.UTF-8");
    let format = Environment::new()?;
    let s = (-1000000).to_formatted_string(&format);
    assert_eq!("-1,000,000", &s);

    Ok(())
}

Methods

impl Environment

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

Constructs a new Environment.

Note

• This method uses the setlocale and localeconv API from C in order to access your system's locale settings specified by the LC_ALL environment variable.
• Because representations of infinity and NaN are not specified in locale files, English representations from the Unicode Common Locale Data Repository (CLDR) are used for these values, which are "∞" (U+221E) and "NaN". You can change these with calls to the set_infinity and set_nan methods.

Errors

Return an error if any of the calls into C fail (e.g. if localeconv return a NULL pointer).

pub fn decimal(&self) -> char

Returns this format's representation of decimal points.

pub fn grouping(&self) -> Grouping

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

pub fn infinity(&self) -> &str

Returns this format's representation of infinity.

pub fn minus_sign(&self) -> &str

Returns this format's representation of minus signs.

pub fn nan(&self) -> &str

Returns this format's representation of NaN.

pub fn separator(&self) -> Option<char>

Returns this format's representation of separators.

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

Sets the string used for infinity.

Errors

Return an error if the length is greater than 64 bytes.

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

Sets the string used for NaN.

Errors

Return an error if the length is greater than 64 bytes.

Trait Implementations

impl Format for Environment

fn decimal(&self) -> char

Returns character to use for representing decimal points.

fn grouping(&self) -> Grouping

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

fn infinity(&self) -> InfinityStr

Returns string to use for representing infinity symbols.

fn minus_sign(&self) -> MinusSignStr

Returns string to use for representing minus signs.

fn nan(&self) -> NanStr

Returns string to use for representing NaN symbols.

fn separator(&self) -> Option<char>

Returns character to use, if any, for representing separators.

impl From<Environment> for CustomFormat

fn from(environment: Environment) -> Self

Performs the conversion.

impl PartialEq<Environment> for Environment

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

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

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

This method tests for !=.

impl Eq for Environment

impl Copy for Environment

impl Clone for Environment

fn clone(&self) -> Environment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Environment

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

Formats the value using the given formatter.

impl Hash for Environment

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].