Struct Collation

#[non_exhaustive]
pub struct Collation {
    pub locale: String,
    pub strength: Option<CollationStrength>,
    pub case_level: Option<bool>,
    pub case_first: Option<CollationCaseFirst>,
    pub numeric_ordering: Option<bool>,
    pub alternate: Option<CollationAlternate>,
    pub max_variable: Option<CollationMaxVariable>,
    pub normalization: Option<bool>,
    pub backwards: Option<bool>,
}

A collation configuration. See the official MongoDB documentation for more information on each of the fields.

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: String

The ICU locale.

See the list of supported languages and locales here.

strength: Option<CollationStrength>

The level of comparison to perform. Corresponds to ICU Comparison Levels.

case_level: Option<bool>

Whether to include a separate level for case differences. See ICU Collation: CaseLevel for more information.

case_first: Option<CollationCaseFirst>

The sort order of case differences during tertiary level comparisons.

numeric_ordering: Option<bool>

Whether to compare numeric strings as numbers or strings.

alternate: Option<CollationAlternate>

Whether collation should consider whitespace and punctuation as base characters for purposes of comparison.

max_variable: Option<CollationMaxVariable>

Up to which characters are considered ignorable when alternate is “shifted”. Has no effect if alternate is set to “non-ignorable”.

normalization: Option<bool>

Whether to check if text require normalization and to perform it.

backwards: Option<bool>

Whether strings with diacritics sort from the back of the string.

Implementations

impl Collation

pub fn builder() -> CollationBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building Collation. On the builder, call .locale(...), .strength(...)(optional), .case_level(...)(optional), .case_first(...)(optional), .numeric_ordering(...)(optional), .alternate(...)(optional), .max_variable(...)(optional), .normalization(...)(optional), .backwards(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Collation.

Trait Implementations

impl Clone for Collation

fn clone(&self) -> Collation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Collation

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

Formats the value using the given formatter.

impl Default for Collation

fn default() -> Collation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Collation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Collation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.