Struct FindOneAndUpdate 

pub struct FindOneAndUpdate<'a, T>
where
    T: Send + Sync,
{ /* private fields */ }

Atomically finds up to one document in the collection matching a filter and updates it. Construct with Collection::find_one_and_update.

Implementations

impl<'a, T> FindOneAndUpdate<'a, T>

where T: Send + Sync,

pub fn session( self, value: impl Into<&'a mut ClientSession>, ) -> FindOneAndUpdate<'a, T>

Use the provided session when running the operation.

pub fn with_options( self, value: impl Into<Option<FindOneAndUpdateOptions>>, ) -> FindOneAndUpdate<'a, T>

Set all options. Note that this will replace all previous values set.

pub fn array_filters( self, value: impl IntoIterator<Item = Document>, ) -> FindOneAndUpdate<'a, T>

A set of filters specifying to which array elements an update should apply.

See the documentation here for more information on array filters.

pub fn bypass_document_validation(self, value: bool) -> FindOneAndUpdate<'a, T>

Opt out of document-level validation.

pub fn max_time(self, value: Duration) -> FindOneAndUpdate<'a, T>

The maximum amount of time to allow the query to run.

This options maps to the maxTimeMS MongoDB query option, so the duration will be sent across the wire as an integer number of milliseconds.

pub fn projection(self, value: Document) -> FindOneAndUpdate<'a, T>

Limits the fields of the document being returned.

pub fn return_document(self, value: ReturnDocument) -> FindOneAndUpdate<'a, T>

Whether the operation should return the document before or after modification.

pub fn sort(self, value: Document) -> FindOneAndUpdate<'a, T>

The order of the documents for the purposes of the operation.

pub fn upsert(self, value: bool) -> FindOneAndUpdate<'a, T>

If true, insert a document if no matching document is found.

pub fn write_concern(self, value: WriteConcern) -> FindOneAndUpdate<'a, T>

The level of the write concern

pub fn collation(self, value: Collation) -> FindOneAndUpdate<'a, T>

The collation to use for the operation.

See the documentation for more information on how to use this option.

pub fn hint(self, value: Hint) -> FindOneAndUpdate<'a, T>

The index to use for the operation. Only available in MongoDB 4.4+.

pub fn let_vars(self, value: Document) -> FindOneAndUpdate<'a, T>

Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. “$$var”).

Only available in MongoDB 5.0+.

pub fn comment(self, value: impl Into<Bson>) -> FindOneAndUpdate<'a, T>

Tags the query with an arbitrary Bson value to help trace the operation through the database profiler, currentOp and logs.

This option is only available on server versions 4.4+.

Trait Implementations

impl<'a, T> Action for FindOneAndUpdate<'a, T>

where T: DeserializeOwned + Send + Sync,

fn optional<Value>( self, value: Option<Value>, f: impl FnOnce(Self, Value) -> Self, ) -> Self

where Self: Sized,

If the value is Some, call the provided function on self. Convenient for chained updates with values that need to be set conditionally. For example:

impl<'a, T> IntoFuture for FindOneAndUpdate<'a, T>

where T: DeserializeOwned + Send + Sync,

type Output = Result<Option<T>, Error>

The output that the future will produce on completion.

type IntoFuture = FindOneAndUpdateFuture<'a, T>

Which kind of future are we turning this into?

fn into_future(self) -> <FindOneAndUpdate<'a, T> as IntoFuture>::IntoFuture

Creates a future from a value.