Struct Lease

pub struct Lease { /* private fields */ }

Represents a held distributed lease & background task to continuously try to extend it until dropped.

On drop asynchronously releases the underlying lock.

Implementations

impl Lease

pub async fn release(self) -> Result<()>

Releases the lease returning Ok(()) after successful deletion.

Note: The local guard is unlocked first before deleting the lease. This avoids other concurrent acquires in the same process being unfairly advantaged in acquiring subsequent leases and potentially causing other processes to be starved.

If you await this method then immediately acquire a lease, e.g. inside a loop, you are acquiring with an unfair advantage vs other process attempts. This may lead to other process being starved of leases.

pub fn is_healthy(&self) -> bool

Returns true if the lease periodic extension task is still running.

If lease extension fails, e.g. due to lost contact with the db, this will return false.

Trait Implementations

impl Debug for Lease

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

Formats the value using the given formatter.

impl Drop for Lease

fn drop(&mut self)

Asynchronously releases the underlying lock.