Struct num2words::Num2Words

pub struct Num2Words { /* private fields */ }

Builder for num2words

Implementations

impl Num2Words

pub fn new<T>(num: T) -> Self where
    T: Into<Number>, 

Creates a new builder

Example:

use num2words::Num2Words;
assert_eq!(
    Num2Words::new(42).to_words(),
    Ok(String::from("forty-two"))
);

pub fn lang(self, lang: Lang) -> Self

Sets the language of the output

For all of the available languages, see Lang.

Example:

use num2words::{Num2Words, Lang};
assert_eq!(
    Num2Words::new(42).lang(Lang::English).to_words(),
    Ok(String::from("forty-two"))
);

pub fn cardinal(self) -> Self

Sets the type of output to cardinal (forty-two)

Example:

use num2words::Num2Words;
assert_eq!(
    Num2Words::new(42).cardinal().to_words(),
    Ok(String::from("forty-two"))
);

pub fn ordinal(self) -> Self

Sets the type of output to ordinal (forty-second)

Example:

use num2words::Num2Words;
assert_eq!(
    Num2Words::new(42).ordinal().to_words(),
    Ok(String::from("forty-second"))
);

pub fn ordinal_num(self) -> Self

Sets the type of output to numbered ordinal (42nd)

Example:

use num2words::Num2Words;
assert_eq!(
    Num2Words::new(42).ordinal_num().to_words(),
    Ok(String::from("42nd"))
);

pub fn year(self) -> Self

Sets the type of output to year (nineteen oh-one)

Example:

use num2words::Num2Words;
assert_eq!(
    Num2Words::new(1901).year().to_words(),
    Ok(String::from("nineteen oh-one"))
);

pub fn currency(self, currency: Currency) -> Self

Sets the output to the currency it has been given

For all of the available currencies, see Currency.

Example:

use num2words::{Num2Words, Currency};
assert_eq!(
    Num2Words::new(42.01).currency(Currency::DOLLAR).to_words(),
    Ok(String::from("forty-two dollars and one cent"))
);

pub fn to_words(self) -> Result<String, Num2Err>

Builds the output