Skip to main content

LandingReservation

Struct LandingReservation 

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

What: One transaction’s view of the reservation: whether another transaction holds it, waiting for it, requesting it, and releasing it. Why: The landing loop takes the reservation after its lost races and must give it back when the loop ends, landed or failed.

In TS you’d write (pseudocode):

type LandingReservation = AsyncDisposable & { awaitSlot; heldByAnother; reserve };

Implementations§

Source§

impl LandingReservation

Source

pub fn open( registry_root: &Path, transaction_directory: &Path, transaction_id: &str, nested: bool, ) -> Self

What: Opens the reservation view for one landing loop. Why: The caller decides nested from its inherited landing lease, which this module does not read.

In TS you’d write (pseudocode):

await openLandingReservation({ registryRoot, transactionDirectory, transactionId });
Source

pub fn held_by_another(&self) -> Result<bool, ReservationError>

What: Whether another transaction holds a live reservation right now. Why: The holder’s own token never counts against itself.

In TS you’d write (pseudocode):

await reservation.heldByAnother();
Source

pub fn await_slot(&self) -> Result<(), ReservationError>

What: Waits while a live reservation owned by another transaction exists. Why: A landing may take the landing lock only after the holder has finished its landing loop.

In TS you’d write (pseudocode):

await reservation.awaitSlot();
Source

pub fn await_slot_for(&self, limit: Duration) -> Result<(), ReservationError>

What: Waits while a live reservation owned by another transaction exists, for at most limit. Why: Tests and the default wait share one loop; only the limit differs.

In TS you’d write (pseudocode):

await reservation.awaitSlot({ limitMs });
Source

pub fn reserve(&mut self, lost_races: u64) -> Result<bool, ReservationError>

What: Writes the request, then waits until this transaction is the oldest live requester and the lock is free, and takes the reservation. Why: The first requester in grant order gets the next slot, so a starving commit cannot be overtaken again. An inherited landing lease neither asks nor waits.

In TS you’d write (pseudocode):

await reservation.reserve(lostRaces); // false when already held or not applicable
Source

pub fn reserve_for( &mut self, lost_races: u64, limit: Duration, ) -> Result<bool, ReservationError>

What: Writes the request and waits for the grant, for at most limit. Why: Tests and the default wait share one loop; only the limit differs.

In TS you’d write (pseudocode):

await reservation.reserve(lostRaces, { limitMs });
Source

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

What: Releases the reservation if held and removes the request file. Why: The request goes even when the reservation was never granted, so no stale request blocks the next grant.

In TS you’d write (pseudocode):

await reservation[Symbol.asyncDispose]();

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