Struct CollatorPreferences

#[non_exhaustive]
pub struct CollatorPreferences {
    pub locale_preferences: LocalePreferences,
    pub collation_type: Option<CollationType>,
    pub case_first: Option<CollationCaseFirst>,
    pub numeric_ordering: Option<CollationNumericOrdering>,
}

The preferences for collation.

Preferences

Examples for using the different preferences below can be found in the crate-level docs.

Case First

See the spec. This is the BCP47 key kf. Three possibilities: CollationCaseFirst::False (default, except for Danish and Maltese), CollationCaseFirst::Lower, and CollationCaseFirst::Upper (default for Danish and Maltese).

Numeric

This is the BCP47 key kn. When set to CollationNumericOrdering::True, any sequence of decimal digits (General_Category = Nd) is sorted at the primary level according to the numeric value. The default is CollationNumericOrdering::False.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

locale_preferences: LocalePreferences

Locale Preferences for the Preferences structure.

collation_type: Option<CollationType>

The collation type. This corresponds to the -u-co BCP-47 tag.

case_first: Option<CollationCaseFirst>

Treatment of case. (Large and small kana differences are treated as case differences.) This corresponds to the -u-kf BCP-47 tag.

numeric_ordering: Option<CollationNumericOrdering>

When set to True, any sequence of decimal digits is sorted at a primary level according to the numeric value. This corresponds to the -u-kn BPC-47 tag.

Implementations

impl CollatorPreferences

pub fn extend(&mut self, other: CollatorPreferences)

Extends the preferences with the values from another set of preferences.

Trait Implementations

impl Clone for CollatorPreferences

fn clone(&self) -> CollatorPreferences

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollatorPreferences

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

Formats the value using the given formatter.

impl Default for CollatorPreferences

fn default() -> CollatorPreferences

Returns the “default value” for a type.

impl From<&LanguageIdentifier> for CollatorPreferences

fn from(lid: &LanguageIdentifier) -> CollatorPreferences

Converts to this type from the input type.

impl From<&Locale> for CollatorPreferences

fn from(loc: &Locale) -> CollatorPreferences

Converts to this type from the input type.

impl From<LanguageIdentifier> for CollatorPreferences

fn from(lid: LanguageIdentifier) -> CollatorPreferences

Converts to this type from the input type.

impl From<Locale> for CollatorPreferences

fn from(loc: Locale) -> CollatorPreferences

Converts to this type from the input type.

impl From<ResolvedCollatorOptions> for CollatorPreferences

fn from(options: ResolvedCollatorOptions) -> CollatorPreferences

Convenience conversion for copying the preferences from an existing collator into a new one.

Note that some preferences may not be fully preserved when recovering them from an already initialized collator e.g LocalePreferences and CollationType, because those are only relevant when loading the collation data.

impl Hash for CollatorPreferences

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

where __H: Hasher,

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 PartialEq for CollatorPreferences

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

impl Eq for CollatorPreferences

impl StructuralPartialEq for CollatorPreferences