Struct ResourceLease 

pub struct ResourceLease<R: Send + 'static> { /* private fields */ }

An exclusive lease on a resource.

Dereferences to the resource itself. Dropping the lease returns the resource to the registry still live, so a lease is a loan, never ownership. See ResourceRegistry for the full model.

This is the head lease. Dropping it relinquishes the holder’s claim, but doesn’t end the resource’s lease while Subleases issued against it are still outstanding: the registry won’t hand the resource to another acquirer until those come back too.

Implementations

impl<R: Send + 'static> ResourceLease<R>

pub fn kind(&self) -> ResourceKind

Returns the kind of this resource.

pub fn key(&self) -> &MetaString

Returns the key this resource is registered under, unique within its kind.

pub fn release(self)

Returns the resource to the registry.

Equivalent to dropping the lease; useful where the return should be obvious at the call site.

pub fn discard(self)

Drops the resource instead of returning it, so the next acquisition creates a fresh one.

Use this when the resource has hit an error it can’t recover from and handing it to the next acquirer would pass the problem along.

Discarding doesn’t free the key any sooner than releasing would. Outstanding Subleases are what hold a subdivided resource open, so the key stays reserved until they come back, and only then does the next acquisition build a replacement – otherwise the replacement would exist alongside the thing being discarded.

Trait Implementations

impl<R: Send + Debug + 'static> Debug for ResourceLease<R>

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

Formats the value using the given formatter.

impl<R: Send + 'static> Deref for ResourceLease<R>

type Target = R

The resulting type after dereferencing.

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

Dereferences the value.

impl<R: Send + 'static> DerefMut for ResourceLease<R>

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

Mutably dereferences the value.

impl<R: Send + 'static> Drop for ResourceLease<R>

fn drop(&mut self)

Executes the destructor for this type.