Struct DirectedReadOptions 

#[non_exhaustive]
pub struct DirectedReadOptions {
    pub replicas: Option<Replicas>,
    /* private fields */
}

The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries.

DirectedReadOptions can only be specified for a read-only transaction, otherwise the API returns an INVALID_ARGUMENT error.

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.

replicas: Option<Replicas>

Required. At most one of either include_replicas or exclude_replicas should be present in the message.

Implementations

impl DirectedReadOptions

pub fn new() -> Self

Creates a new default instance.

pub fn set_replicas<T: Into<Option<Replicas>>>(self, v: T) -> Self

Sets the value of replicas.

Note that all the setters affecting replicas are mutually exclusive.

pub fn include_replicas(&self) -> Option<&Box<IncludeReplicas>>

The value of replicas if it holds a IncludeReplicas, None if the field is not set or holds a different branch.

pub fn set_include_replicas<T: Into<Box<IncludeReplicas>>>(self, v: T) -> Self

Sets the value of replicas to hold a IncludeReplicas.

Note that all the setters affecting replicas are mutually exclusive.

pub fn exclude_replicas(&self) -> Option<&Box<ExcludeReplicas>>

The value of replicas if it holds a ExcludeReplicas, None if the field is not set or holds a different branch.

pub fn set_exclude_replicas<T: Into<Box<ExcludeReplicas>>>(self, v: T) -> Self

Sets the value of replicas to hold a ExcludeReplicas.

Note that all the setters affecting replicas are mutually exclusive.

Trait Implementations

impl Clone for DirectedReadOptions

fn clone(&self) -> DirectedReadOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DirectedReadOptions

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

Formats the value using the given formatter.

impl Default for DirectedReadOptions

fn default() -> DirectedReadOptions

Returns the “default value” for a type.

impl Message for DirectedReadOptions

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DirectedReadOptions

fn eq(&self, other: &DirectedReadOptions) -> 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 StructuralPartialEq for DirectedReadOptions