Struct mongodb::options::SessionOptions

#[non_exhaustive]
pub struct SessionOptions {
    pub default_transaction_options: Option<TransactionOptions>,
    pub causal_consistency: Option<bool>,
    pub snapshot: Option<bool>,
}

Contains the options that can be used to create a new ClientSession.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

default_transaction_options: Option<TransactionOptions>

The default options to use for transactions started on this session.

If these options are not specified, they will be inherited from the Client associated with this session. They will not be inherited from the options specified on the Database or Collection associated with the operations within the transaction.

causal_consistency: Option<bool>

If true, all operations performed in the context of this session will be causally consistent.

Defaults to true if SessionOptions::snapshot is unspecified.

snapshot: Option<bool>

If true, all read operations performed using this client session will share the same snapshot. Defaults to false.

Implementations

impl SessionOptions

pub fn builder() -> SessionOptionsBuilder<((), (), ())>

Create a builder for building SessionOptions. On the builder, call .default_transaction_options(...)(optional), .causal_consistency(...)(optional), .snapshot(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of SessionOptions.

Trait Implementations

impl Clone for SessionOptions

fn clone(&self) -> SessionOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.