Struct icu_plurals :: PluralRulesWithRanges Copy item path

impl PluralRulesWithRanges<PluralRules>

pub fn try_new( locale: &DataLocale, rule_type: PluralRuleType, ) -> Result<Self, DataError>

Constructs a new PluralRulesWithRanges for a given locale using compiled data.

✨ Enabled with the compiled_data Cargo feature.

§Examples

use icu::locale::locale;
use icu::plurals::{PluralRuleType, PluralRulesWithRanges};

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

✨ Enabled with the compiled_data Cargo feature.

pub fn try_new_with_any_provider( provider: &(impl AnyProvider + ?Sized), locale: &DataLocale, rule_type: PluralRuleType, ) -> Result<Self, DataError>

A version of Self::try_new that uses custom data provided by an AnyProvider.

pub fn try_new_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), locale: &DataLocale, rule_type: PluralRuleType, ) -> Result<Self, DataError>

A version of Self::try_new that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

pub fn try_new_unstable( provider: &(impl DataProvider<PluralRangesV1Marker> + DataProvider<CardinalV1Marker> + DataProvider<OrdinalV1Marker> + ?Sized), locale: &DataLocale, rule_type: PluralRuleType, ) -> Result<Self, DataError>

A version of Self::try_new that uses custom data provided by a DataProvider.

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

pub fn try_new_cardinal(locale: &DataLocale) -> Result<Self, DataError>

Constructs a new PluralRulesWithRanges for a given locale for cardinal numbers using compiled data.

See PluralRules::try_new_cardinal for more information.

✨ Enabled with the compiled_data Cargo feature.

§Examples

use icu::locale::locale;
use icu::plurals::{PluralCategory, PluralRulesWithRanges};

let rules = PluralRulesWithRanges::try_new_cardinal(&locale!("ru").into())
    .expect("locale should be present");

assert_eq!(rules.category_for_range(0_usize, 2_usize), PluralCategory::Few);

✨ Enabled with the compiled_data Cargo feature.

pub fn try_new_cardinal_with_any_provider( provider: &(impl AnyProvider + ?Sized), locale: &DataLocale, ) -> Result<Self, DataError>

A version of Self::try_new_cardinal that uses custom data provided by an AnyProvider.

pub fn try_new_cardinal_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), locale: &DataLocale, ) -> Result<Self, DataError>

A version of Self::try_new_cardinal that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

pub fn try_new_cardinal_unstable( provider: &(impl DataProvider<CardinalV1Marker> + DataProvider<PluralRangesV1Marker> + ?Sized), locale: &DataLocale, ) -> Result<Self, DataError>

A version of Self::try_new_cardinal that uses custom data provided by a DataProvider.

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

pub fn try_new_ordinal(locale: &DataLocale) -> Result<Self, DataError>

Constructs a new PluralRulesWithRanges for a given locale for ordinal numbers using compiled data.

See PluralRules::try_new_ordinal for more information.

✨ Enabled with the compiled_data Cargo feature.

§Examples

use icu::locale::locale;
use icu::plurals::{PluralCategory, PluralRulesWithRanges};

let rules = PluralRulesWithRanges::try_new_ordinal(
    &locale!("ru").into(),
)
.expect("locale should be present");

assert_eq!(rules.category_for_range(0_usize, 2_usize), PluralCategory::Other);

✨ Enabled with the compiled_data Cargo feature.

pub fn try_new_ordinal_with_any_provider( provider: &(impl AnyProvider + ?Sized), locale: &DataLocale, ) -> Result<Self, DataError>

A version of Self::try_new_ordinal that uses custom data provided by an AnyProvider.

pub fn try_new_ordinal_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), locale: &DataLocale, ) -> Result<Self, DataError>

A version of Self::try_new_ordinal that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

pub fn try_new_ordinal_unstable( provider: &(impl DataProvider<OrdinalV1Marker> + DataProvider<PluralRangesV1Marker> + ?Sized), locale: &DataLocale, ) -> Result<Self, DataError>

A version of Self::try_new_ordinal that uses custom data provided by a DataProvider.

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

impl<R> PluralRulesWithRanges<R>
where R: AsRef<PluralRules>,

pub fn try_new_with_rules( locale: &DataLocale, rules: R, ) -> Result<Self, DataError>

Constructs a new PluralRulesWithRanges for a given locale from an existing PluralRules (either owned or as a reference) and compiled data.

§⚠️ Warning

The provided locale MUST be the same as the locale provided to the constructor of rules. Otherwise, Self::category_for_range will return incorrect results.

✨ Enabled with the compiled_data Cargo feature.

§Examples

use icu::locale::locale;
use icu::plurals::{PluralRuleType, PluralRulesWithRanges, PluralRules};

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

let _ =
    PluralRulesWithRanges::try_new_with_rules(&locale!("en").into(), rules)
        .expect("locale should be present");

✨ Enabled with the compiled_data Cargo feature.

pub fn try_new_with_rules_with_any_provider( provider: &(impl AnyProvider + ?Sized), locale: &DataLocale, rules: R, ) -> Result<Self, DataError>

A version of Self::try_new_with_rules that uses custom data provided by an AnyProvider.

pub fn try_new_with_rules_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), locale: &DataLocale, rules: R, ) -> Result<Self, DataError>

A version of Self::try_new_with_rules that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

pub fn try_new_with_rules_unstable( provider: &(impl DataProvider<PluralRangesV1Marker> + ?Sized), locale: &DataLocale, rules: R, ) -> Result<Self, DataError>

A version of Self::try_new_with_rules that uses custom data provided by a DataProvider.

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

pub fn rules(&self) -> &PluralRules

Gets a reference to the inner PluralRules.

§Examples

use icu::locale::locale;
use icu::plurals::{PluralCategory, PluralRulesWithRanges};

let ranges = PluralRulesWithRanges::try_new_cardinal(&locale!("en").into())
    .expect("locale should be present");

let rules = ranges.rules();

assert_eq!(rules.category_for(1u8), PluralCategory::One);

pub fn category_for_range<S: Into<PluralOperands>, E: Into<PluralOperands>>( &self, start: S, end: E, ) -> PluralCategory

Returns the Plural Category appropriate for a range.

Note that the returned category is correct only if the range fulfills the following requirements:

The start value is strictly less than the end value.
Both values are positive.

§Examples

use icu::locale::locale;
use icu::plurals::{
    PluralCategory, PluralOperands, PluralRuleType, PluralRulesWithRanges,
};

let ranges = PluralRulesWithRanges::try_new(
    &locale!("ro").into(),
    PluralRuleType::Cardinal,
)
.expect("locale should be present");
let operands: PluralOperands =
    "0.5".parse().expect("parsing to operands should succeed");
let operands2 = PluralOperands::from(1_usize);

assert_eq!(
    ranges.category_for_range(operands, operands2),
    PluralCategory::Few
);

pub fn resolve_range( &self, start: PluralCategory, end: PluralCategory, ) -> PluralCategory

Returns the Plural Category appropriate for a range from the categories of its endpoints.

Note that the returned category is correct only if the original numeric range fulfills the following requirements:

The start value is strictly less than the end value.
Both values are positive.

§Examples

use icu::locale::locale;
use icu::plurals::{PluralCategory, PluralRuleType, PluralRulesWithRanges};

let ranges = PluralRulesWithRanges::try_new(
    &locale!("sl").into(),
    PluralRuleType::Ordinal,
)
.expect("locale should be present");

assert_eq!(
    ranges.resolve_range(PluralCategory::Other, PluralCategory::One),
    PluralCategory::Few
);

Trait Implementations§

impl<R: Debug> Debug for PluralRulesWithRanges<R>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<R> UnwindSafe for PluralRulesWithRanges<R>
where R: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> ErasedDestructor for T
where T: 'static,