Struct mongodb::options::SessionOptions
source · [−]#[non_exhaustive]pub struct SessionOptions {
pub default_transaction_options: Option<TransactionOptions>,
pub causal_consistency: Option<bool>,
pub snapshot: Option<bool>,
}
Expand description
Contains the options that can be used to create a new
ClientSession
.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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
sourceimpl SessionOptions
impl SessionOptions
sourcepub fn builder() -> SessionOptionsBuilder<((), (), ())>
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
sourceimpl Clone for SessionOptions
impl Clone for SessionOptions
sourcefn clone(&self) -> SessionOptions
fn clone(&self) -> SessionOptions
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SessionOptions
impl Debug for SessionOptions
sourceimpl<'de> Deserialize<'de> for SessionOptions
impl<'de> Deserialize<'de> for SessionOptions
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl !RefUnwindSafe for SessionOptions
impl Send for SessionOptions
impl Sync for SessionOptions
impl Unpin for SessionOptions
impl !UnwindSafe for SessionOptions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more