Struct StepHandle 

pub struct StepHandle<T, S> { /* private fields */ }

A way to obtain a step’s result.

This handle can be used to transfer data between steps.

StepHandles must be awaited:

1. Either within a future step,
2. Or after the engine completes executing.

To ensure this, the only way to retrieve a StepHandle is with a StepHandleToken, returned by:

• StepContext::token
• MetadataContext::token
• CompletionContext::token

It is important that StepHandles never be awaited outside the context of a step that comes afterwards – doing so will cause an immediate deadlock.

Dropping a StepHandle has no effect on whether the step itself runs.

Implementations

impl<T, S> StepHandle<T, S>

pub fn ready(value: T) -> Self

Creates a StepHandle that immediately provides a value.

The value is always available and can be used within any steps.

pub async fn into_value(self, _token: &StepHandleToken<S>) -> T

Resolves to the output from a step, T.

pub fn into_shared(self) -> SharedStepHandle<T, S>

where T: Clone,

Returns a shared handle.

A SharedStepHandle can be used to retrieve the output of a future across multiple dependent steps.

Trait Implementations

impl<T, S> Debug for StepHandle<T, S>

where T: Debug,

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

Formats the value using the given formatter.