Struct WriteConcern

#[non_exhaustive]
pub struct WriteConcern {
    pub w: Option<Acknowledgment>,
    pub w_timeout: Option<Duration>,
    pub journal: Option<bool>,
}

Specifies the level of acknowledgement requested from the server for write operations.

See the documentation here for more information about write concerns.

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.

w: Option<Acknowledgment>

Requests acknowledgement that the operation has propagated to a specific number or variety of servers.

w_timeout: Option<Duration>

Specifies a time limit for the write concern. If an operation has not propagated to the requested level within the time limit, an error will return.

Note that an error being returned due to a write concern error does not imply that the write would not have finished propagating if allowed more time to finish, and the server will not roll back the writes that occurred before the timeout was reached.

journal: Option<bool>

Requests acknowledgement that the operation has propagated to the on-disk journal.

Implementations

impl WriteConcern

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

Create a builder for building WriteConcern. On the builder, call .w(...)(optional), .w_timeout(...)(optional), .journal(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of WriteConcern.

impl WriteConcern

pub fn nodes(v: u32) -> WriteConcern

A ‘WriteConcern’ requesting Acknowledgment::Nodes.

pub fn majority() -> WriteConcern

A WriteConcern requesting Acknowledgment::Majority.

pub fn custom(s: impl AsRef<str>) -> WriteConcern

A WriteConcern with a custom acknowledgment.

Trait Implementations

impl Clone for WriteConcern

fn clone(&self) -> WriteConcern

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WriteConcern

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

Formats the value using the given formatter.

impl Default for WriteConcern

fn default() -> WriteConcern

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WriteConcern

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Acknowledgment> for WriteConcern

fn from(w: Acknowledgment) -> WriteConcern

Converts to this type from the input type.

impl PartialEq for WriteConcern

fn eq(&self, other: &WriteConcern) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WriteConcern

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WriteConcern