Struct mongodb::options::ClusteredIndex

#[non_exhaustive]
pub struct ClusteredIndex {
    pub key: Document,
    pub unique: bool,
    pub name: Option<String>,
    pub v: Option<i32>,
}

Specifies options for a clustered collection. Some fields have required values; the Default impl uses those values.

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.

key: Document

Key pattern; currently required to be {_id: 1}.

unique: bool

Currently required to be true.

name: Option<String>

Optional; will be automatically generated if not provided.

v: Option<i32>

Optional; currently must be 2 if provided.

Trait Implementations

impl Clone for ClusteredIndex

fn clone(&self) -> ClusteredIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClusteredIndex

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

Formats the value using the given formatter.

impl Default for ClusteredIndex

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClusteredIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ClusteredIndex

fn eq(&self, other: &ClusteredIndex) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ClusteredIndex

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClusteredIndex