Struct dynamodb_lease::Client

pub struct Client { /* private fields */ }

Client for acquiring Leases.

Communicates with dynamodb to acquire, extend and delete distributed leases.

Local mutex locks are also used to eliminate db contention for usage within a single Client instance or clone.

Implementations

impl Client

pub fn builder() -> ClientBuilder

Returns a new Client builder.

pub async fn try_acquire(&self, key: impl Into<String>) -> Result<Option<Lease>>

Trys to acquire a new Lease for the given key.

If this lease has already been acquired elsewhere Ok(None) is returned.

Does not wait to acquire a lease, to do so see Client::acquire.

pub async fn acquire(&self, key: impl Into<String>) -> Result<Lease>

Acquires a new Lease for the given key. May wait until successful if the lease has already been acquired elsewhere.

To try to acquire without waiting see Client::try_acquire.

pub async fn acquire_timeout(
    &self,
    key: impl Into<String>,
    max_wait: Duration
) -> Result<Lease>

Acquires a new Lease for the given key. May wait until successful if the lease has already been acquired elsewhere up to a max of max_wait.

To try to acquire without waiting see Client::try_acquire.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.