Enum icu_plurals::PluralCategory

#[repr(u8)]
pub enum PluralCategory {
    Zero = 0,
    One = 1,
    Two = 2,
    Few = 3,
    Many = 4,
    Other = 5,
}

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::locale;
use icu::plurals::{PluralCategory, PluralRuleType, PluralRules};

let pr =
    PluralRules::try_new(&locale!("en").into(), PluralRuleType::Cardinal)
        .expect("locale should be present");

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

Variants

Zero = 0

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 = 1

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 = 2

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 = 3

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 = 4

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 = 5

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(crate) fn new_from_u8(value: u8) -> Option<Self>

Attempt to construct the value from its corresponding integer, returning None if not possible

impl PluralCategory

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

Returns an ordered iterator over variants of Plural Categories.

Categories are returned in alphabetical order.

Examples

use icu::plurals::PluralCategory;

let mut categories = PluralCategory::all();

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

pub fn get_for_cldr_string(category: &str) -> Option<PluralCategory>

Returns the PluralCategory corresponding to given TR35 string.

pub fn get_for_cldr_bytes(category: &[u8]) -> Option<PluralCategory>

Returns the PluralCategory corresponding to given TR35 string as bytes

Trait Implementations

impl AsULE for PluralCategory

type ULE = PluralCategoryULE

The ULE type corresponding to Self.

fn to_unaligned(self) -> Self::ULE

Converts from Self to Self::ULE.

fn from_unaligned(other: Self::ULE) -> Self

Converts from Self::ULE to Self.

impl Clone for PluralCategory

fn clone(&self) -> PluralCategory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PluralCategory

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

Formats the value using the given formatter.

impl Hash for PluralCategory

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 Ord for PluralCategory

fn cmp(&self, other: &PluralCategory) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PluralCategory

fn eq(&self, other: &PluralCategory) -> 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 PartialOrd for PluralCategory

fn partial_cmp(&self, other: &PluralCategory) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> ZeroMapKV<'a> for PluralCategory

type Container = ZeroVec<'a, PluralCategory>

The container that can be used with this type: ZeroVec or VarZeroVec.

type Slice = ZeroSlice<PluralCategory>

type GetType = PluralCategoryULE

The type produced by Container::get()

type OwnedType = PluralCategory

The type produced by Container::replace() and Container::remove(), also used during deserialization. If Self is human readable serialized, deserializing to Self::OwnedType should produce the same value once passed through Self::owned_as_self()

impl Copy for PluralCategory

impl Eq for PluralCategory

impl StructuralPartialEq for PluralCategory