Struct DeliveryHandle 

pub struct DeliveryHandle<D> { /* private fields */ }

The operations of an instance whose delivery an EntryDelivery owns, through &self from any thread. The handler is given one; the owner derefs to its own, so both offer the same operations from one definition.

Each call takes the front end’s lock on the instance for its duration – dioring’s lock in DI-D-18’s order, taken before the ring’s – and the handler is called with that lock released.

What it withholds

• pop and readiness: the delivery is the single deliverer and the signal’s one waiter (DI-D-28). A second popper would take entries out of order; a second waiter would steal wakes.
• Any &mut to the instance, including through a closure. Safe code could then replace the instance while the wait stayed armed on the old one’s signal, and delivery would stop without an error – the ring crate’s measured defect (D-43), which a closure does not close. Registered bytes are therefore reached through closures over the bytes alone.

Not constructible, and not Clone: a handler holds one only for the length of a call, so it cannot keep the front end alive.

Implementations

impl<D: DurableRing> DeliveryHandle<D>

pub fn add_target( &self, key: IoTargetKey, target: D::Target, ) -> Result<(), AddTargetError<D::Target>>

DurableRing::add_target.

Errors

As DurableRing::add_target.

pub fn remove_target( &self, key: IoTargetKey, ) -> Result<D::Target, RemoveTargetError<D::Ids>>

DurableRing::remove_target.

Errors

As DurableRing::remove_target.

pub fn default_lineage(&self) -> HandleOf<D>

DurableRing::default_lineage.

pub fn mint_lineage(&self, description: Option<String>) -> HandleOf<D>

DurableRing::mint_lineage.

pub fn lineages(&self) -> Vec<LineageInfo<D::Ids>>

DurableRing::lineages.

pub fn end_lineage( &self, handle: HandleOf<D>, ) -> Result<(), EndLineageError<D::Ids>>

DurableRing::end_lineage.

Errors

As DurableRing::end_lineage.

pub fn retire_lineage( &self, handle: HandleOf<D>, ) -> Result<(), RetireLineageError<D::Ids>>

DurableRing::retire_lineage.

Errors

As DurableRing::retire_lineage.

pub fn write( &self, file: IoTargetKey, offset: u64, buffer: D::Buffer, tag: Tag<'_, D::Ids>, context: D::Context, ) -> PushResult<D>

where D::Buffer: IoBuf,

DurableRing::write.

Errors

As DurableRing::write.

pub fn write_with( &self, file: IoTargetKey, offset: u64, buffer: D::Buffer, tag: Tag<'_, D::Ids>, context: D::Context, options: WriteOptions<D::Ids>, ) -> PushResult<D>

where D::Buffer: IoBuf,

DurableRing::write_with.

Errors

As DurableRing::write_with.

pub fn read( &self, file: IoTargetKey, offset: u64, buffer: D::Buffer, context: D::Context, ) -> PushResult<D>

where D::Buffer: IoBufMut,

DurableRing::read.

Errors

As DurableRing::read.

pub fn read_with( &self, file: IoTargetKey, offset: u64, buffer: D::Buffer, context: D::Context, options: ReadOptions<D::Ids>, ) -> PushResult<D>

where D::Buffer: IoBufMut,

DurableRing::read_with.

Errors

As DurableRing::read_with.

pub fn make_durable_through( &self, through: Tag<'_, D::Ids>, ) -> Result<DurabilityRequest<D::Ids>, SealError<D::Ids>>

DurableRing::make_durable_through.

Errors

As DurableRing::make_durable_through.

pub fn durable_through( &self, lineage: Lin<D>, ) -> Result<Option<EpochIdOf<D>>, UnknownLineage<D::Ids>>

DurableRing::durable_through.

Errors

As DurableRing::durable_through.

pub fn sealed_through( &self, lineage: Lin<D>, ) -> Result<Option<EpochIdOf<D>>, UnknownLineage<D::Ids>>

DurableRing::sealed_through.

Errors

As DurableRing::sealed_through.

pub fn epoch_state( &self, epoch: Epoch<D::Ids>, ) -> Result<EpochState<D::Ids>, UnknownLineage<D::Ids>>

DurableRing::epoch_state.

Errors

As DurableRing::epoch_state.

pub fn resolve( &self, items: Vec<(TokenOf<D>, Resolution)>, ) -> Result<(), ResolveError<D::Ids>>

DurableRing::resolve.

Errors

As DurableRing::resolve.

pub fn import_failure( &self, scope: ImportScope<D::Ids>, ) -> Result<Imported<D::Ids>, UnknownLineage<D::Ids>>

DurableRing::import_failure.

Errors

As DurableRing::import_failure.

pub fn failures(&self) -> Vec<FailureInfo<D::Ids>>

DurableRing::failures.

pub fn take_token(&self, failure: FailureIdOf<D>) -> Option<TokenOf<D>>

DurableRing::take_token.

impl<D: RegisteredBufferRing> DeliveryHandle<D>

pub fn with_registered_buffer<R>( &self, i: u32, f: impl FnOnce(&[u8]) -> R, ) -> Result<R>

Run f on the bytes of registered buffer i, under the front end’s lock.

Errors

As RegisteredBufferRing::with_registered_buffer.

pub fn with_registered_buffer_mut<R>( &self, i: u32, f: impl FnOnce(&mut [u8]) -> R, ) -> Result<R>

Run f on the bytes of registered buffer i, mutably, under the front end’s lock.

Errors

As RegisteredBufferRing::with_registered_buffer_mut.

pub fn write_registered( &self, file: IoTargetKey, offset: u64, span: RegisteredSpan, tag: Tag<'_, D::Ids>, context: D::Context, ) -> PushResult<D>

RegisteredBufferRing::write_registered.

Errors

As RegisteredBufferRing::write_registered.

pub fn write_registered_with( &self, file: IoTargetKey, offset: u64, span: RegisteredSpan, tag: Tag<'_, D::Ids>, context: D::Context, options: WriteOptions<D::Ids>, ) -> PushResult<D>

RegisteredBufferRing::write_registered_with.

Errors

As RegisteredBufferRing::write_registered_with.

pub fn read_registered( &self, file: IoTargetKey, offset: u64, span: RegisteredSpan, context: D::Context, ) -> PushResult<D>

RegisteredBufferRing::read_registered.

Errors

As RegisteredBufferRing::read_registered.

pub fn read_registered_with( &self, file: IoTargetKey, offset: u64, span: RegisteredSpan, context: D::Context, options: ReadOptions<D::Ids>, ) -> PushResult<D>

RegisteredBufferRing::read_registered_with.

Errors

As RegisteredBufferRing::read_registered_with.