Struct mongod::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

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

source

impl Client

source

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.

source

pub fn builder() -> ClientBuilder

Creates a ClientInner to configure a Client.

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

source

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

Constructs a new Client using a mongodb::Client.

source

pub fn client(&self) -> Client

Returns the mongodb::Client

source

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

Returns the mongodb::Document from the mongodb.

source

pub fn database(&self) -> Database

Returns the mongodb::Database from the mongodb.

source

pub async fn delete<C, F>(&self, filter: Option<F>) -> Result<u64, 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.

source

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.

source

pub async fn find<C, F>(
 &self,
 filter: Option<F>
) -> Result<TypedCursor<C>, 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.

source

pub async fn find_one<C, F>(
 &self,
 filter: F
) -> Result<Option<(ObjectId, 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.

source

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.

source

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.

source

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.

source

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

Convenience method to update documents in a collection.

Errors

This method fails if the mongodb encountered an error.

source

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

Convenience method to update one document from a collection.

Errors

This method fails if the mongodb encountered an error.

source

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

Convenience method to upsert documents from a collection.

Errors

This method fails if the mongodb encountered an error.

source

pub async fn upsert_one<C, F, U>(
 &self,
 filter: F,
 updates: Updates
) -> Result<bool, Error> where
 C: AsFilter<F> + AsUpdate + 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

source

impl Clone for Client

source

fn clone(&self) -> Client

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

source

impl Default for Client

source

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

pub 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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct mongod::Client

Implementations

impl Client

pub fn new() -> Self

pub fn builder() -> ClientBuilder

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

pub fn client(&self) -> Client

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

pub fn database(&self) -> Database

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

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

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

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

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

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

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

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,

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,

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,

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,

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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

impl Default for Client

fn default() -> Self

Auto Trait Implementations

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

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

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

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

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

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,

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,

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,

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,

impl<T> Any for T where
T: 'static + ?Sized,

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

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

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

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,