Skip to main content

OwnerLock

Struct OwnerLock 

Source
pub struct OwnerLock { /* private fields */ }
Expand description

What: A held owner lock. Releasing it proves the lock still names this holder first. Dropping an unreleased lock releases it and ignores a failure. Why: An early return or an unwinding error must not leave a live-looking lock behind; an explicit release reports a changed owner.

In TS you’d write (pseudocode):

type OwnerLock = AsyncDisposable & { lockDirectory: string; token: string };

Implementations§

Source§

impl OwnerLock

Accessors and release of a held lock.

Source

pub fn inherited(directory: &Path, token: &str) -> OwnerLock

What: A view of a lock an ancestor process holds, which releases nothing. Why: An invocation nested under a landing-lock holder proves it with an inherited lease and proceeds under the ancestor’s lock instead of waiting for it (inheritedLandingLock in the incumbent).

In TS you’d write (pseudocode):

{ lockDirectory, token: process.env[LANDING_LEASE_ENV], [Symbol.asyncDispose]: async () => {} }
Source

pub fn directory(&self) -> &Path

What: The published lock directory. Why: Leases and diagnostics name the lock.

In TS you’d write (pseudocode):

lock.lockDirectory
Source

pub fn token(&self) -> &str

What: The token this holder published. Why: A lease proves which acquisition it belongs to.

In TS you’d write (pseudocode):

lock.token
Source

pub fn release(self) -> Result<(), OwnerLockError>

What: Release the lock, failing when it no longer names this holder. mut self takes ownership: a released lock cannot be used again. Why: The release is the incumbent’s releaseHeldLock.

In TS you’d write (pseudocode):

await lock[Symbol.asyncDispose]();

Trait Implementations§

Source§

impl Debug for OwnerLock

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for OwnerLock

Dropping an unreleased lock releases it.

Source§

fn drop(&mut self)

What: Release the lock unless release already did; a failure is ignored. Why: Nothing can be reported from a drop, and a lock that changed owner is not this holder’s to remove.

In TS you’d write (pseudocode):

// `await using` disposal on an early exit.
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more