Skip to main content

HandlerInput

Struct HandlerInput 

Source
pub struct HandlerInput {
    pub run_id: RunId,
    pub attempt_id: AttemptId,
    pub payload: Vec<u8>,
    pub metadata: AttemptMetadata,
    pub cancellation_context: CancellationContext,
}
Expand description

Execution context provided to the handler for each attempt.

This structure contains all information needed to execute an attempt including the run and attempt identifiers, the payload to execute, and constraints snapshot for timeout and retry behavior.

§Cancellation contract

  • If metadata.timeout_secs is Some, timeout enforcement may request cancellation while execution is in progress.
  • Long-running handlers must poll CancellationToken::is_cancelled() at bounded intervals and exit promptly once cancellation is observed.
  • Returning success after cancellation has been requested does not override timeout truth; timeout classification remains authoritative.

Fields§

§run_id: RunId

The unique identifier for the run instance.

§attempt_id: AttemptId

The unique identifier for this specific attempt within the run.

§payload: Vec<u8>

The opaque payload bytes to execute.

§metadata: AttemptMetadata

The attempt-level execution metadata (timeout, retry policy, etc.).

§cancellation_context: CancellationContext

The cancellation context for this execution. Handlers can check this to determine if execution should be terminated early.

Trait Implementations§

Source§

impl Clone for HandlerInput

Source§

fn clone(&self) -> HandlerInput

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HandlerInput

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.