Struct qm_mongodb::action::Watch

pub struct Watch<'a, T = Document, S = ImplicitSession> { /* private fields */ }

Starts a new ChangeStream that receives events for all changes in a given scope. Create by calling Client::watch, Database::watch, or Collection::watch.

Implementations

impl<'a, S> Watch<'a, S>

pub fn pipeline(self, value: impl IntoIterator<Item = Document>) -> Watch<'a, S>

Apply an aggregation pipeline to the change stream.

Note that using a $project stage to remove any of the _id, operationType or ns fields will cause an error. The driver requires these fields to support resumability. For more information on resumability, see the documentation for ChangeStream

If the pipeline alters the structure of the returned events, the parsed type will need to be changed via ChangeStream::with_type.

pub fn resume_after(self, value: impl Into<Option<ResumeToken>>) -> Watch<'a, S>

Specifies the logical starting point for the new change stream. Note that if a watched collection is dropped and recreated or newly renamed, start_after should be set instead. resume_after and start_after cannot be set simultaneously.

For more information on resuming a change stream see the documentation here

pub fn with_options( self, value: impl Into<Option<ChangeStreamOptions>>, ) -> Watch<'a, S>

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

pub fn full_document(self, value: FullDocumentType) -> Watch<'a, S>

Set the ChangeStreamOptions::full_document option.

pub fn full_document_before_change( self, value: FullDocumentBeforeChangeType, ) -> Watch<'a, S>

Set the ChangeStreamOptions::full_document_before_change option.

pub fn start_at_operation_time(self, value: Timestamp) -> Watch<'a, S>

Set the ChangeStreamOptions::start_at_operation_time option.

pub fn start_after(self, value: ResumeToken) -> Watch<'a, S>

Set the ChangeStreamOptions::start_after option.

pub fn max_await_time(self, value: Duration) -> Watch<'a, S>

Set the ChangeStreamOptions::max_await_time option.

pub fn batch_size(self, value: u32) -> Watch<'a, S>

Set the ChangeStreamOptions::batch_size option.

pub fn collation(self, value: Collation) -> Watch<'a, S>

Set the ChangeStreamOptions::collation option.

pub fn read_concern(self, value: ReadConcern) -> Watch<'a, S>

Set the ChangeStreamOptions::read_concern option.

pub fn selection_criteria(self, value: SelectionCriteria) -> Watch<'a, S>

Set the ChangeStreamOptions::selection_criteria option.

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

Set the ChangeStreamOptions::comment option.

impl<'a, T> Watch<'a, T>

pub fn session<'s>( self, session: impl Into<&'s mut ClientSession>, ) -> Watch<'a, T, ExplicitSession<'s>>

Use the provided [‘ClientSession’].

Trait Implementations

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

where T: DeserializeOwned + Unpin + 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> Action for Watch<'a, T, ExplicitSession<'a>>

where T: DeserializeOwned + Unpin + 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 Watch<'a, T>

where T: DeserializeOwned + Unpin + Send + Sync,

type Output = Result<ChangeStream<ChangeStreamEvent<T>>, Error>

The output that the future will produce on completion.

type IntoFuture = WatchFuture<'a, T>

Which kind of future are we turning this into?

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

Creates a future from a value.

impl<'a, T> IntoFuture for Watch<'a, T, ExplicitSession<'a>>

where T: DeserializeOwned + Unpin + Send + Sync,

type Output = Result<SessionChangeStream<ChangeStreamEvent<T>>, Error>

The output that the future will produce on completion.

type IntoFuture = WatchSessionFuture<'a, T>

Which kind of future are we turning this into?

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

Creates a future from a value.