Struct mongod::query::Delete

pub struct Delete<C: Collection> { /* fields omitted */ }

A querier to delete documents from a MongoDB collection.

Examples

Delete all documents from a collection.

#[derive(Bson, Mongo)]
#[mongo(collection="users", field, filter, update)]
pub struct User {
    name: String,
}

let client = mongod::Client::new();

let deleted = mongod::query::Delete::<User>::new()
    .query(&client)
    .await
    .unwrap();

println!("delete {} documents", deleted);

Implementations

impl<C: Collection> Delete<C>

pub fn new() -> Self

Constructs a Delete querier.

pub fn collation(mut self: Self, collation: Collation) -> Self

The collation to use for the operation.

Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.

pub fn filter<F>(mut self: Self, filter: F) -> Result<Self, Error> where
    C: AsFilter<F>,
    F: Filter, 

The filter to use for the operation.

Errors

This method errors if the filter could not be converted into a BSON Document.

pub fn hint(mut self: Self, hint: Hint) -> Self

A document or string that specifies the index to use to support the query predicate.

pub fn many(mut self: Self, many: bool) -> Self

Enable delete many for this operation.

Removes all documents that match the filter from a collection.

pub fn write_concern(mut self: Self, write_concern: WriteConcern) -> Self

The write concern for the operation.

pub async fn query(self, client: &Client) -> Result<i64, Error>

Query the database with this querier.

Errors

This method fails if the mongodb encountered an error.

pub fn blocking(self, client: &Client) -> Result<i64, Error>

Query the database with this querier in a blocking context.

Optional

This requires the optional blocking feature to be enabled.

Errors

This method fails if the mongodb encountered an error.

Trait Implementations

impl<C: Clone + Collection> Clone for Delete<C>

fn clone(&self) -> Delete<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Collection> Default for Delete<C>

fn default() -> Self

Returns the "default value" for a type.