Struct etcd_client::LeaseClient

#[repr(transparent)]
pub struct LeaseClient { /* fields omitted */ }

Client for lease operations.

Implementations

impl LeaseClient

pub async fn grant(
    &mut self,
    ttl: i64,
    options: Option<LeaseGrantOptions>
) -> Result<LeaseGrantResponse, Error>

Creates a lease which expires if the server does not receive a keepAlive within a given time to live period. All keys attached to the lease will be expired and deleted if the lease expires. Each expired key generates a delete event in the event history.

pub async fn revoke(&mut self, id: i64) -> Result<LeaseRevokeResponse, Error>

Revokes a lease. All keys attached to the lease will expire and be deleted.

pub async fn keep_alive(
    &mut self,
    id: i64
) -> Result<(LeaseKeeper, LeaseKeepAliveStream), Error>

Keeps the lease alive by streaming keep alive requests from the client to the server and streaming keep alive responses from the server to the client.

pub async fn time_to_live(
    &mut self,
    id: i64,
    options: Option<LeaseTimeToLiveOptions>
) -> Result<LeaseTimeToLiveResponse, Error>

Retrieves lease information.

pub async fn leases(&mut self) -> Result<LeaseLeasesResponse, Error>

Lists all existing leases.

Trait Implementations

impl Clone for LeaseClient

fn clone(&self) -> LeaseClient

Returns a copy of the value.

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

Performs copy-assignment from source.