n2words 0.1.0

Convert numbers to words in 50 languages (72 regional variants): cardinal, ordinal and currency forms, with arbitrary-precision input
Documentation
//! English (Pakistan) (`en-PK`): a locale profile of [`en_in`](crate::en_in).
//!
//! Numerals are identical to Indian English (South Asian lakh/crore numerals
//! in 3-2-2 grouping, "and" after hundreds); only the default currency
//! differs (PKR). Any currency English has words for is still reachable
//! through the `currency` option.
//!
//! ```
//! use n2words::en_pk::to_currency;
//!
//! assert_eq!(to_currency(42.5)?, "forty-two rupees and fifty paise");
//! # Ok::<(), n2words::Error>(())
//! ```

use crate::Result;
use crate::currency::Currency;
use crate::currency::vocab::EN as CURRENCY_VOCAB;
use crate::en_in;
use crate::language::{Kind, Language, form};
use crate::number::Number;
use crate::options::options;

pub use crate::en_in::{CARDINAL_MAX, CURRENCY_MAX, ORDINAL_MAX, to_cardinal, to_ordinal};

/// The full implementation this profile delegates to.
pub const VARIANT_OF: &str = "en-IN";

options! {
    /// Options for [`to_currency_with`].
    pub struct CurrencyOptions {
        /// Use "and" between the major and minor unit
        and: bool = true;
        /// ISO 4217 currency code to name the amount in
        currency: Currency = Currency::PKR, table = CURRENCY_VOCAB;
    }
}

/// Spells an amount in Pakistani rupees.
///
/// # Errors
///
/// As [`en_in::to_currency`].
pub fn to_currency<'a>(value: impl Into<Number<'a>>) -> Result<String> {
    to_currency_with(value, &CurrencyOptions::default())
}

/// Spells an amount in any currency English has words for.
///
/// # Errors
///
/// As [`en_in::to_currency_with`].
pub fn to_currency_with<'a>(
    value: impl Into<Number<'a>>,
    options: &CurrencyOptions,
) -> Result<String> {
    en_in::to_currency_with(
        value,
        &en_in::CurrencyOptions {
            and: options.and,
            currency: options.currency,
        },
    )
}

/// Registry entry for `en-PK`.
pub static LANGUAGE: Language = Language {
    code: "en-PK",
    name: "English (Pakistan)",
    kind: Kind::Profile { base: VARIANT_OF },
    cardinal: Some(form!(plain to_cardinal, CARDINAL_MAX)),
    ordinal: Some(form!(plain to_ordinal, ORDINAL_MAX)),
    currency: Some(form!(with_options to_currency_with, CurrencyOptions, CURRENCY_MAX)),
};