Struct mongodb::options::ReadPreferenceOptions [−][src]
#[non_exhaustive]pub struct ReadPreferenceOptions {
pub tag_sets: Option<Vec<TagSet>>,
pub max_staleness: Option<Duration>,
pub hedge: Option<HedgedReadOptions>,
}
Expand description
Specifies read preference options for non-primary read preferences.
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.tag_sets: Option<Vec<TagSet>>
Specifies which replica set members should be considered for operations. Each tag set will be checked in order until one or more servers is found with each tag in the set.
max_staleness: Option<Duration>
Specifies the maximum amount of lag behind the primary that a secondary can be to be
considered for the given operation. Any secondaries lagging behind more than
max_staleness
will not be considered for the operation.
max_staleness
must be at least 90 seconds. If a max_staleness
less than 90 seconds is
specified for an operation, the operation will return an error.
hedge: Option<HedgedReadOptions>
Specifies hedging behavior for reads. These options only apply to sharded clusters on servers that are at least version 4.4. Note that hedged reads are automatically enabled for read preference mode “nearest”.
See the MongoDB docs for more details.
Implementations
Create a builder for building ReadPreferenceOptions
.
On the builder, call .tag_sets(...)
(optional), .max_staleness(...)
(optional), .hedge(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of ReadPreferenceOptions
.
Trait Implementations
Returns the “default value” for a type. Read more
fn 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
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for ReadPreferenceOptions
impl Send for ReadPreferenceOptions
impl Sync for ReadPreferenceOptions
impl Unpin for ReadPreferenceOptions
impl UnwindSafe for ReadPreferenceOptions
Blanket Implementations
Mutably borrows from an owned value. Read more