Enum mongodm::index::IndexOption

source · [−]

pub enum IndexOption {
    Background,
    Unique,
    Name(String),
    PartialFilterExpression(Document),
    Sparse,
    ExpireAfterSeconds(i32),
    StorageEngine(Document),
    Collation(Document),
    Custom {
        name: String,
        value: Bson,
    },
}

Expand description

Option to be used at index creation.

Variants

`Background`

Enable background builds

`Unique`

Creates a unique index

`Name(String)`

Name of the index

`PartialFilterExpression(Document)`

Only references documents that match the filter expression

`Sparse`

Only references documents with the specified field

`ExpireAfterSeconds(i32)`

TTL to control how long data is retained in the collectino

`StorageEngine(Document)`

Configure the storage engine

`Collation(Document)`

Specifies the collation

`Custom`

Fields

name: String

value: Bson

Specify a custom index option. This is present to provide forwards compatibility.

Implementations

impl IndexOption

pub fn name(&self) -> &str

pub fn into_value(self) -> Bson

pub fn into_key_value(self) -> (String, Bson )

Trait Implementations

impl Clone for IndexOption

fn clone(&self) -> IndexOption

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for IndexOption

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for IndexOption

impl Send for IndexOption

impl Sync for IndexOption

impl Unpin for IndexOption

impl UnwindSafe for IndexOption

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

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> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V