Struct mungos::options::ReadPreferenceOptions
source · [−]#[non_exhaustive]pub struct ReadPreferenceOptions {
pub tag_sets: Option<Vec<HashMap<String, String, RandomState>, Global>>,
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<HashMap<String, String, RandomState>, Global>>
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
sourceimpl ReadPreferenceOptions
impl ReadPreferenceOptions
sourcepub fn builder() -> ReadPreferenceOptionsBuilder<((), (), ())>
pub fn builder() -> ReadPreferenceOptionsBuilder<((), (), ())>
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
sourceimpl Clone for ReadPreferenceOptions
impl Clone for ReadPreferenceOptions
sourcefn clone(&self) -> ReadPreferenceOptions
fn clone(&self) -> ReadPreferenceOptions
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 ReadPreferenceOptions
impl Debug for ReadPreferenceOptions
sourceimpl Default for ReadPreferenceOptions
impl Default for ReadPreferenceOptions
sourcefn default() -> ReadPreferenceOptions
fn default() -> ReadPreferenceOptions
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for ReadPreferenceOptions
impl<'de> Deserialize<'de> for ReadPreferenceOptions
sourcefn deserialize<__D>(
__deserializer: __D
) -> Result<ReadPreferenceOptions, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<ReadPreferenceOptions, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<ReadPreferenceOptions> for ReadPreferenceOptions
impl PartialEq<ReadPreferenceOptions> for ReadPreferenceOptions
sourcefn eq(&self, other: &ReadPreferenceOptions) -> bool
fn eq(&self, other: &ReadPreferenceOptions) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ReadPreferenceOptions) -> bool
fn ne(&self, other: &ReadPreferenceOptions) -> bool
This method tests for !=
.
sourceimpl Serialize for ReadPreferenceOptions
impl Serialize for ReadPreferenceOptions
sourcefn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
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. Read more
impl StructuralPartialEq for ReadPreferenceOptions
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
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