Enum CollationType

#[non_exhaustive]
pub enum CollationType {
    Compat,
    Dict,
    Ducet,
    Emoji,
    Eor,
    Phonebk,
    Phonetic,
    Pinyin,
    Search,
    Searchjl,
    Standard,
    Stroke,
    Trad,
    Unihan,
    Zhuyin,
}

A Unicode Collation Identifier defines a type of collation (sort order).

The valid values are listed in LDML.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Compat

A previous version of the ordering, for compatibility

Dict

Dictionary style ordering (such as in Sinhala)

Ducet

The default Unicode collation element table order

Emoji

Recommended ordering for emoji characters

Eor

European ordering rules

Phonebk

Phonebook style ordering (such as in German)

Phonetic

Phonetic ordering (sorting based on pronunciation)

Pinyin

Pinyin ordering for Latin and for CJK characters (used in Chinese)

Search

Special collation type for string search

Searchjl

Special collation type for Korean initial consonant search

Standard

Default ordering for each language

Stroke

Pinyin ordering for Latin, stroke order for CJK characters (used in Chinese)

Trad

Traditional style ordering (such as in Spanish)

Unihan

Pinyin ordering for Latin, Unihan radical-stroke ordering for CJK characters (used in Chinese)

Zhuyin

Pinyin ordering for Latin, zhuyin order for Bopomofo and CJK characters (used in Chinese)

Implementations

impl CollationType

pub const fn as_str(&self) -> &'static str

A helper function for displaying as a &str.

Trait Implementations

impl Clone for CollationType

fn clone(&self) -> CollationType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollationType

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

Formats the value using the given formatter.

impl From<CollationType> for Value

fn from(input: CollationType) -> Value

Converts to this type from the input type.

impl Hash for CollationType

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 CollationType

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

fn unicode_extension_key() -> Option<Key>

Retrieve unicode extension key corresponding to a given preference.

fn try_from_key_value( key: &Key, value: &Value, ) -> Result<Option<CollationType>, PreferencesParseError>

Optional constructor of the given preference. It takes the unicode extension key and if the key matches it attemptes to construct the preference based on the given value. If the value is not a valid value for the given key, the constructor throws.

fn unicode_extension_value(&self) -> Option<Value>

Retrieve unicode extension value corresponding to the given instance of the preference.

impl TryFrom<&Value> for CollationType

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from( s: &Value, ) -> Result<CollationType, <CollationType as TryFrom<&Value>>::Error>

Performs the conversion.

impl Copy for CollationType

impl Eq for CollationType

impl StructuralPartialEq for CollationType