Struct KVDeleteKeyQuery

pub struct KVDeleteKeyQuery {
    pub dc: Option<String>,
    pub recurse: Option<bool>,
    pub cas: Option<u64>,
}

Fields

dc: Option<String>

Specifies the datacenter to query. This will default to the datacenter of the agent being queried. If the DC is invalid, the error “No path to datacenter” is returned.

recurse: Option<bool>

Specifies to delete all keys which have the specified prefix. Without this, only a key with an exact match will be deleted.

cas: Option<u64>

Specifies to use a Check-And-Set operation. This is very useful as a building block for more complex synchronization primitives. Unlike PUT, the index must be greater than 0 for Consul to take any action: a 0 index will not delete the key. If the index is non-zero, the key is only deleted if the index matches the ModifyIndex of that key.

Trait Implementations

impl Debug for KVDeleteKeyQuery

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

Formats the value using the given formatter.

impl Default for KVDeleteKeyQuery

fn default() -> KVDeleteKeyQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KVDeleteKeyQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for KVDeleteKeyQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.