Struct ReadKeyRequest 

pub struct ReadKeyRequest<'a> {
    pub key: &'a str,
    pub namespace: &'a str,
    pub datacenter: &'a str,
    pub recurse: bool,
    pub separator: &'a str,
    pub consistency: ConsistencyMode,
    pub index: Option<u64>,
    pub wait: Duration,
}

Represents a request to read a key from Consul’s Key Value store.

Fields

key: &'a str

Specifies the path of the key to read.

namespace: &'a str

Specifies the namespace to query. If not provided, the namespace will be inferred from the request’s ACL token, or will default to the default namespace. For recursive lookups, the namespace may be specified as ‘*’ and then results will be returned for all namespaces. Added in Consul 1.7.0.

datacenter: &'a str

Specifies the datacenter to query. This will default to the datacenter of the agent being queried.

recurse: bool

Specifies if the lookup should be recursive and key treated as a prefix instead of a literal match.

separator: &'a str

Specifies the string to use as a separator for recursive key lookups. This option is only used when paired with the keys parameter to limit the prefix of keys returned, only up to the given separator.

consistency: ConsistencyMode

The consistency mode for reads. See also ConsistencyMode

index: Option<u64>

Endpoints that support blocking queries return an HTTP header named X-Consul-Index. This is a unique identifier representing the current state of the requested resource. On subsequent requests for this resource, the client can set the index query string parameter to the value of X-Consul-Index, indicating that the client wishes to wait for any changes subsequent to that index.

wait: Duration

The time to wait for watching a lock in a blocking fashion.

Implementations

impl<'a> ReadKeyRequest<'a>

pub fn builder() -> ReadKeyRequestBuilder<'a>

Create an instance of ReadKeyRequest using the builder syntax

Trait Implementations

impl<'a> Clone for ReadKeyRequest<'a>

fn clone(&self) -> ReadKeyRequest<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ReadKeyRequest<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ReadKeyRequest<'a>

fn default() -> Self

Return ReadKeyRequest { key: Default::default(), namespace: Default::default(), datacenter: Default::default(), recurse: Default::default(), separator: Default::default(), consistency: Default::default(), index: Default::default(), wait: Default::default() }

impl<'de: 'a, 'a> Deserialize<'de> for ReadKeyRequest<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq for ReadKeyRequest<'a>

fn eq(&self, other: &ReadKeyRequest<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> Serialize for ReadKeyRequest<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for ReadKeyRequest<'a>