Struct potential::Lease

pub struct Lease<T> { /* fields omitted */ }

The leased item. Item will be sent back to the owner on drop() unless stolen with steal().

Lease does not allow empty state so as long as it exists, it must have the item.

As long as Lease exists, Potential will be waiting for return (unless reset). Drop Lease or steal it to release the wait.

Implementations

impl<T> Lease<T>

pub fn close(self) -> Option<T>

Return the lease to owner, destroying the lease. If the owner doesn't listen anymore, the item is returned to caller.

pub fn replace(&mut self, replacement: T) -> T

Replace the item within the lease

pub fn steal(self) -> T

Steal the leased item destroying the lease. Potential await calls will return None.

Trait Implementations

impl<T: Debug> Debug for Lease<T>

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

Formats the value using the given formatter.

impl<T> Deref for Lease<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Lease<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Drop for Lease<T>

fn drop(&mut self)

drop() must be called for the item to return to the owner. Otherwise, the owner will be stuck waiting forever.