Struct QueryOptions 

pub struct QueryOptions {

    pub datacenter: Option<String>,
    pub allow_stale: bool,
    pub require_consistent: bool,
    pub use_cache: bool,
    pub max_age: Option<Duration>,
    pub stale_if_error: Option<Duration>,
    pub wait_index: u64,
    pub wait_time: Option<Duration>,
    pub token: Option<String>,
    pub namespace: Option<String>,
    pub partition: Option<String>,
    pub near: Option<String>,
    pub node_meta: HashMap<String, String>,
    pub filter: Option<String>,
}

Query options for read operations

Fields

datacenter: Option<String>

Datacenter to query

allow_stale: bool

AllowStale allows stale queries

require_consistent: bool

RequireConsistent forces consistent queries

use_cache: bool

UseCache uses Consul’s caching feature

max_age: Option<Duration>

MaxAge limits how old a cached value will be returned

stale_if_error: Option<Duration>

StaleIfError allows stale read on error

wait_index: u64

WaitIndex for blocking queries

wait_time: Option<Duration>

WaitTime for blocking queries

token: Option<String>

Token for ACL authentication

namespace: Option<String>

Namespace (Enterprise only)

partition: Option<String>

Partition (Enterprise only)

near: Option<String>

Near sorts by nearest node

node_meta: HashMap<String, String>

NodeMeta filters by node metadata

filter: Option<String>

Filter expression for filtering results

Implementations

impl QueryOptions

pub fn new() -> Self

pub fn with_token(self, token: &str) -> Self

pub fn with_datacenter(self, dc: &str) -> Self

pub fn with_namespace(self, ns: &str) -> Self

pub fn with_wait(self, index: u64, wait_time: Duration) -> Self

pub fn with_stale(self) -> Self

pub fn with_consistent(self) -> Self

Trait Implementations

impl Clone for QueryOptions

fn clone(&self) -> QueryOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryOptions

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

Formats the value using the given formatter.

impl Default for QueryOptions

fn default() -> QueryOptions

Returns the “default value” for a type.