Struct DeleteKeyRequest 

pub struct DeleteKeyRequest<'a> {
    pub key: &'a str,
    pub datacenter: &'a str,
    pub recurse: bool,
    pub check_and_set: u32,
    pub namespace: &'a str,
}

Represents a request to delete a key or all keys sharing a prefix from Consul’s Key Value store.

Fields

key: &'a str

Specifies the path of the key to delete.

datacenter: &'a str

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

recurse: bool

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

check_and_set: u32

Specifies to use a Check-And-Set operation. This is very useful as a building block for more complex synchronization primitives. 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.

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.

Implementations

impl<'a> DeleteKeyRequest<'a>

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

Create an instance of DeleteKeyRequest using the builder syntax

Trait Implementations

impl<'a> Clone for DeleteKeyRequest<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DeleteKeyRequest<'a>

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

Formats the value using the given formatter.

impl<'a> Default for DeleteKeyRequest<'a>

fn default() -> Self

Return DeleteKeyRequest { key: Default::default(), datacenter: Default::default(), recurse: Default::default(), check_and_set: Default::default(), namespace: Default::default() }

impl<'de: 'a, 'a> Deserialize<'de> for DeleteKeyRequest<'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 DeleteKeyRequest<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> Serialize for DeleteKeyRequest<'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 DeleteKeyRequest<'a>