Crate num2words

Expand description

Convert number like 42 to forty-two

Usage

This crate can be either used as a library or a binary.

Library

Example usage:

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

The builder Num2Words can take any of these arguments: lang, cardinal, ordinal, ordinal_num, year, and currency.

use num2words::*;
assert_eq!(
    Num2Words::new(42).lang(Lang::English).to_words(),
    Ok(String::from("forty-two"))
);
assert_eq!(
    Num2Words::new(42).ordinal().to_words(),
    Ok(String::from("forty-second"))
);
assert_eq!(
    Num2Words::new(42.01).currency(Currency::DOLLAR).to_words(),
    Ok(String::from("forty-two dollars and one cent"))
);

These arguments can be chained.

For more information about the available languages, outputs and currencies, see Information.

Binary

This crate provides a command-line interface to run requests on num2words.

Example:

$ num2words 42
forty-two
$ num2words 10 --to EUR
ten euros

You can download the app via the following command:

$ cargo install num2words

You can also change the language via the argument --lang and provide an output or a currency with the argument --to.

For more information about the usage of num2words please refer to the docs or via the following command:

$ num2words --help

Information

Supported languages

Here is a list of all of the supported languages:

Flag	Code	CLI code	Language	42
🇺🇸🇬🇧	`Lang::English`	`en`	English	forty-two

This list can be expanded! Contributions are welcomed.

Supported output

Here is a list of all of the supported outputs (with the command-line interface code):

Output::Cardinal (cardinal): forty-two (42)
Output::Currency (any available currencies): forty-two dollars and one cent (42.01)
Output::Ordinal (ordinal): forty-second (42)
Output::OrdinalNum (ordinal_num): 42nd (42)
Output::Year (year): nineteen oh-one (1901)

Supported currencies

Here is a list of all of the supported currencies (with the command-line interface code):

Currency::AUD (AUD): australian dollar
Currency::CAD (CAD): canadian dollar
Currency::DOLLAR (DOLLAR): dollar
Currency::EUR (EUR): euro
Currency::GBP (GBP): pound
Currency::USD (USD): US dollar

About

This library is widely inspired by Savoir-faire Linux’s Python lib.

Structs

Num2Words

Builder for num2words

Enums

Currency

Defines currencies

Lang

Languages available in num2words

Num2Err

Error type returned by the builder