Struct mongodb::common::ReadPreference

pub struct ReadPreference {
    pub mode: ReadMode,
    pub tag_sets: Vec<BTreeMap<String, String>>,
}

Fields

mode: ReadMode

Indicates how a server should be selected during read operations.

tag_sets: Vec<BTreeMap<String, String>>

Filters servers based on the first tag set that matches at least one server.

Methods

impl ReadPreference

pub fn new(
    mode: ReadMode,
    tag_sets: Option<Vec<BTreeMap<String, String>>>
) -> ReadPreference

pub fn to_document(&self) -> Document

Trait Implementations

impl Eq for ReadPreference

impl Clone for ReadPreference

fn clone(&self) -> ReadPreference

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<ReadPreference> for ReadPreference

fn partial_cmp(&self, other: &ReadPreference) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ReadPreference) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ReadPreference) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ReadPreference) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ReadPreference) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for ReadPreference

fn cmp(&self, other: &ReadPreference) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ReadPreference> for ReadPreference

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Hash for ReadPreference

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for ReadPreference

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

Formats the value using the given formatter.