Struct mongod::Client

pub struct Client { /* fields omitted */ }

An asynchronous Client to query mongo with.

The client uses sane defaults but these can be tweaked using the builder. To configure a Client, use Client::builder.

The Client holds a connection pool internally, so it is advised that you create once, and reuse it.

Implementations

impl Client

pub fn new() -> Self

Constructs a new Client.

Panics

This method panics if the mongodb::Client fails to initialise.

Use Client::builder() if you wish to handle this failure as an Error instead of panicking.

pub fn builder() -> ClientBuilder

Creates a ClientInner to configure a Client.

This is the same as ClientBuilder::new().

pub fn from_client<I: Into<String>>(client: Client, database: I) -> Self

Constructs a new Client using a mongodb::Client.

pub fn client(&self) -> Client

Returns the mongodb::Client

pub fn collection<C>(&self) -> Collection where
    C: Collection, 

Returns the mongodb::Document from the mongodb.

pub fn database(&self) -> Database

Returns the mongodb::Database from the mongodb.

pub async fn delete<C, F>(&self, filter: Option<F>) -> Result<i64, Error> where
    C: AsFilter<F> + Collection,
    F: Filter, 

Convenience method to delete documents from a collection using a given filter.

Errors

This method fails if the mongodb encountered an error.

pub async fn delete_one<C, F>(&self, filter: F) -> Result<bool, Error> where
    C: AsFilter<F> + Collection,
    F: Filter, 

Convenience method to delete one document from a collection using a given filter.

Errors

This method fails if the mongodb encountered an error.

pub async fn find<C, F>(&self, filter: Option<F>) -> Result<Cursor, Error> where
    C: AsFilter<F> + Collection,
    F: Filter, 

Convenience method to find documents in a collection.

This function is mainly intended for use cases where the filter is known to return unique hits. If you need something more complicated use find or the FindBuilder.

Errors

This method fails if the mongodb encountered an error.

pub async fn find_one<C, F>(&self, filter: F) -> Result<Option<C>, Error> where
    C: AsFilter<F> + Collection,
    F: Filter, 

Convenience method to find a document in a collection using a given filter.

This function is mainly intended for use cases where the filter is known to return unique hits. If you need something more complicated use find or the FindBuilder.

Errors

This method fails if the mongodb encountered an error, or if the found document is invalid.

pub async fn insert<C>(
    &self,
    documents: Vec<C>
) -> Result<HashMap<usize, ObjectId>, Error> where
    C: Collection, 

Convenience method to insert documents in a collection.

Errors

This method fails if the mongodb encountered an error, or if the found document is invalid.

pub async fn insert_one<C>(&self, document: C) -> Result<ObjectId, Error> where
    C: Collection, 

Convenience method to insert a document in a collection.

Errors

This method fails if the mongodb encountered an error, or if the found document is invalid.

pub async fn replace_one<C, F>(
    &self,
    filter: F,
    document: C
) -> Result<bool, Error> where
    C: AsFilter<F> + Collection,
    F: Filter, 

Convenience method to replace a document in a collection.

Errors

This method fails if the mongodb encountered an error.

pub async fn update<C, F, U>(
    &self,
    filter: F,
    updates: Updates<U>
) -> Result<i64, Error> where
    C: AsFilter<F> + AsUpdate<U> + Collection,
    F: Filter,
    U: Update, 

Convenience method to update documents in a collection.

Errors

This method fails if the mongodb encountered an error.

pub async fn update_one<C, F, U>(
    &self,
    filter: F,
    updates: Updates<U>
) -> Result<bool, Error> where
    C: AsFilter<F> + AsUpdate<U> + Collection,
    F: Filter,
    U: Update, 

Convenience method to update one document from a collection.

Errors

This method fails if the mongodb encountered an error.

pub async fn upsert<C, F, U>(
    &self,
    filter: F,
    updates: Updates<U>
) -> Result<i64, Error> where
    C: AsFilter<F> + AsUpdate<U> + Collection,
    F: Filter,
    U: Update, 

Convenience method to upsert documents from a collection.

Errors

This method fails if the mongodb encountered an error.

pub async fn upsert_one<C, F, U>(
    &self,
    filter: F,
    updates: Updates<U>
) -> Result<bool, Error> where
    C: AsFilter<F> + AsUpdate<U> + Collection,
    F: Filter,
    U: Update, 

Convenience method to upsert one document from a collection.

Errors

This method fails if the mongodb encountered an error.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.