Struct plurr::Plurr

pub struct Plurr<'a> { /* fields omitted */ }

Implementations

impl<'a> Plurr<'a>

pub fn new() -> Self

pub fn locale(&mut self, locale_code: &'a str) -> &mut Self

Sets the locale for Plurr. If this is not called or an incompatible locale_code is provided, it defaults to English.

pub fn auto_plurals(&mut self, auto_plurals: bool) -> &mut Self

Toggles the auto-plural behavior.

• With auto-plurals, Plurr will automatically select the plural form for the current locale.
• Without auto-plurals, you will need to manually provide an N_PLURAL parameter before calling format().

pub fn strict(&mut self, strict: bool) -> &mut Self

Toggles strict mode. In strict mode, errors are not skipped.

pub fn param<T: ToString>(&mut self, key: &str, value: T) -> &mut Self

Stores a parameter value. Parameters must be fed before calling format().

pub fn format(&mut self, value: &str) -> Result<String, PlurrError>

Formats a Plurr string and returns the evaluated string.

For the format spec please check out the project README.

Examples

use plurr::Plurr;

let mut p = Plurr::new();
let s = "Delete {N_PLURAL:{N} file|{N} files}?";

assert_eq!(
    p.param("N", "5").format(s),
    Ok("Delete 5 files?".to_string())
);

Trait Implementations

impl<'a> Debug for Plurr<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Plurr<'a>

fn default() -> Self

Returns the "default value" for a type.