Enum Term

pub enum Term<'a> {
    Simple {
        singular: &'a str,
    },
    Explicit {
        singular: &'a str,
        plural: &'a str,
    },
}

A struct which formats the given value in either singular (1) or plural (2+).

Examples

assert_eq!(Term::simple("word").with(1).to_string(), "word");
assert_eq!(Term::simple("word").with(2).to_string(), "words");
assert_eq!(Term::new("index", "indices").with(1).to_string(), "index");
assert_eq!(Term::new("index", "indices").with(2).to_string(), "indices");

Variants

Simple

Construct the plural term by appending an s.

Fields

singular: &'a str

The singular term which can be turned into plural by appending an s.

Explicit

Explicitly use the give singular and plural term.

Fields

singular: &'a str

The singular term.

plural: &'a str

The plural term.

Implementations

impl<'a> Term<'a>

pub const fn simple(singular: &'a str) -> Self

Creates a new simple term whose plural term is created by appending an s.

pub const fn new(singular: &'a str, plural: &'a str) -> Self

Creates a term from the explicit singular and plural form.

pub fn with(self, plural: impl Plural) -> impl Display + 'a

Formats this term with the given value.

Examples

assert_eq!(Term::simple("word").with(1).to_string(), "word");
assert_eq!(Term::simple("word").with(2).to_string(), "words");
assert_eq!(Term::new("index", "indices").with(1).to_string(), "index");
assert_eq!(Term::new("index", "indices").with(2).to_string(), "indices");

Trait Implementations

impl<'a> Clone for Term<'a>

fn clone(&self) -> Term<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Term<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Term<'a>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Term<'a>

fn eq(&self, other: &Term<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for Term<'a>

impl<'a> Eq for Term<'a>

impl<'a> StructuralPartialEq for Term<'a>