Enum icu_plurals::PluralCategory

pub enum PluralCategory {
    Zero,
    One,
    Two,
    Few,
    Many,
    Other,
}

The plural categories are used to format messages with numeric placeholders, expressed as decimal numbers.

The fundamental rule for determining plural categories is the existence of minimal pairs: whenever two different numbers may require different versions of the same message, then the numbers have different plural categories.

All languages supported by ICU4X can match any number to one of the categories.

Examples

use icu::locid::macros::langid;
use icu::plurals::{PluralRules, PluralRuleType, PluralCategory};
use icu_provider::inv::InvariantDataProvider;

let lid = langid!("en");

let dp = InvariantDataProvider;

let pr = PluralRules::try_new(lid, &dp, PluralRuleType::Cardinal)
    .expect("Failed to construct a PluralRules struct.");

assert_eq!(pr.select(5_usize), PluralCategory::Other);

Variants

Zero

CLDR “zero” plural category. Used in Arabic and Latvian, among others.

Examples of numbers having this category:

• 0 in Arabic (ar), Latvian (lv)
• 10~20, 30, 40, 50, … in Latvian (lv)

One

CLDR “one” plural category. Signifies the singular form in many languages.

Examples of numbers having this category:

• 0 in French (fr), Portuguese (pt), …
• 1 in English (en) and most other languages
• 2.1 in Filipino (fil), Croatian (hr), Latvian (lv), Serbian (sr)
• 2, 3, 5, 7, 8, … in Filipino (fil)

Two

CLDR “two” plural category. Used in Arabic, Hebrew, and Slovenian, among others.

Examples of numbers having this category:

• 2 in Arabic (ar), Hebrew (iw), Slovenian (sl)
• 2.0 in Arabic (ar)

Few

CLDR “few” plural category. Used in Romanian, Polish, Russian, and others.

Examples of numbers having this category:

• 0 in Romanian (ro)
• 1.2 in Croatian (hr), Romanian (ro), Slovenian (sl), Serbian (sr)
• 2 in Polish (pl), Russian (ru), Czech (cs), …
• 5 in Arabic (ar), Lithuanian (lt), Romanian (ro)

Many

CLDR “many” plural category. Used in Polish, Russian, Ukrainian, and others.

Examples of numbers having this category:

• 0 in Polish (pl)
• 1.0 in Czech (cs), Slovak (sk)
• 1.1 in Czech (cs), Lithuanian (lt), Slovak (sk)
• 15 in Arabic (ar), Polish (pl), Russian (ru), Ukrainian (uk)

Other

CLDR “other” plural category, used as a catch-all. Each language supports it, and it is also used as a fail safe result for in case no better match can be identified.

In some languages, such as Japanese, Chinese, Korean, and Thai, this is the only plural category.

Examples of numbers having this category:

• 0 in English (en), German (de), Spanish (es), …
• 1 in Japanese (ja), Korean (ko), Chinese (zh), Thai (th), …
• 2 in English (en), German (de), Spanish (es), …

Implementations

impl PluralCategory

pub fn all() -> impl ExactSizeIterator<Item = &'static Self>

Returns an ordered iterator over variants of Plural Categories.

Examples

use icu::plurals::PluralCategory;

let mut categories = PluralCategory::all();

assert_eq!(categories.next(), Some(&PluralCategory::Zero));
assert_eq!(categories.next(), Some(&PluralCategory::One));
assert_eq!(categories.next(), Some(&PluralCategory::Two));
assert_eq!(categories.next(), Some(&PluralCategory::Few));
assert_eq!(categories.next(), Some(&PluralCategory::Many));
assert_eq!(categories.next(), Some(&PluralCategory::Other));
assert_eq!(categories.next(), None);

Trait Implementations

impl Clone for PluralCategory

fn clone(&self) -> PluralCategory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PluralCategory

impl Debug for PluralCategory

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

Formats the value using the given formatter.

impl Eq for PluralCategory

impl Hash for PluralCategory

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<PluralCategory> for PluralCategory

fn eq(&self, other: &PluralCategory) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl StructuralEq for PluralCategory

impl StructuralPartialEq for PluralCategory