Struct LockRequest 

pub struct LockRequest<'a> {
    pub key: &'a str,
    pub session_id: &'a str,
    pub namespace: &'a str,
    pub datacenter: &'a str,
    pub timeout: Duration,
    pub behavior: LockExpirationBehavior,
    pub lock_delay: Duration,
}

Represents a request to create a lock .

Fields

key: &'a str

The key to use for locking.

session_id: &'a str

The name of the session to use.

namespace: &'a str

Specifies the namespace to use. If not provided, the namespace will be inferred from the request’s ACL token, or will default to the default namespace. This is specified as part of the URL as a query parameter. 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. This is specified as part of the URL as a query parameter.

timeout: Duration

Specifies the duration of a session (between 10s and 86400s). If provided, the session is invalidated if it is not renewed before the TTL expires. The lowest practical TTL should be used to keep the number of managed sessions low. When locks are forcibly expired, such as when following the leader election pattern in an application, sessions may not be reaped for up to double this TTL, so long TTL values (> 1 hour) should be avoided. Defaults to 10 seconds.

behavior: LockExpirationBehavior

Controls the behavior to take when a session is invalidated. See also LockExpirationBehavior

lock_delay: Duration

Specifies the duration for the lock delay. Defaults to 1 second.

Implementations

impl<'a> LockRequest<'a>

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

Create an instance of LockRequest using the builder syntax

Trait Implementations

impl<'a> Clone for LockRequest<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for LockRequest<'a>

impl<'a> Debug for LockRequest<'a>

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

Formats the value using the given formatter.

impl<'a> Default for LockRequest<'a>

fn default() -> Self

Return LockRequest { key: Default::default(), session_id: Default::default(), namespace: Default::default(), datacenter: Default::default(), timeout: Duration :: from_secs(10), behavior: Default::default(), lock_delay: Duration :: from_secs(1) }

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

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

Equality operator ==.

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

Inequality operator !=.

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