Struct TerminalEffects 

pub struct TerminalEffects { /* private fields */ }

Effects staged by a TerminalHook during a notification delivery, applied in the same transaction as the notification job’s acknowledgement.

Passed to TerminalHook::on_termination. Beyond the KV writes and deletes of EffectsHandle (validated by the same rules), a hook stages follow-up enqueues, so work driven by a run’s termination is created atomically with the notification being acknowledged. Effects are applied only when the hook returns Ok; a retried hook stages its effects again.

The handle is sealed once the hook returns; staging through a clone retained past that point returns Error::EffectsSealed. Use TerminalEffects::detached when invoking a hook directly in tests.

Implementations

impl TerminalEffects

pub fn detached() -> Self

Build a handle bound to no delivery, for invoking a TerminalHook directly in tests. A detached handle accepts and validates effects like a delivery-bound one, is never sealed and its staged effects are never applied.

pub fn enqueue(&self, request: EnqueueRequest) -> Result<()>

Stage a follow-up enqueue, committed with the notification’s acknowledgement.

Errors

Error::EffectsSealed when the hook has returned.

pub fn put( &self, key: impl Into<Vec<u8>>, value: impl Into<Vec<u8>>, ) -> Result<()>

Stage a write of value under key in the caller KV namespace.

Errors

As EffectsHandle::put.

pub fn delete(&self, key: impl Into<Vec<u8>>) -> Result<()>

Stage a delete of key from the caller KV namespace.

Errors

As EffectsHandle::delete.

Trait Implementations

impl Clone for TerminalEffects

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TerminalEffects

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

Formats the value using the given formatter.