Struct Context 

pub struct Context {
    pub config: Arc<Config>,
    pub run_id: String,
    /* private fields */
}

Per-run shared state handed to tasks.

Fields

config: Arc<Config>

Immutable run configuration.

run_id: String

Unique id for this run.

Implementations

impl Context

pub fn new(config: Arc<Config>) -> Self

Build a context for a new run.

pub fn for_tests() -> Arc<Self>

A context with default configuration — handy in tests.

pub fn cancel_token(&self) -> &CancelToken

The cancellation token for this run.

pub fn cancel(&self)

Request cancellation of the whole run.

pub fn is_cancelled(&self) -> bool

Whether the run has been cancelled.

pub fn set(&self, key: impl Into<String>, value: Value)

Store a value on the blackboard, overwriting any existing entry.

pub fn get(&self, key: &str) -> Option<Value>

Fetch (and clone) a value from the blackboard.

pub fn get_as<T: DeserializeOwned>(&self, key: &str) -> Option<T>

Deserialize a blackboard value into a concrete type.

pub fn emit(&self, name: &str)

Emit a named event, waking any tasks waiting on it.

pub async fn wait_for(&self, name: &str) -> bool

Wait for a named event to be emitted.

Resolves early (returning false) if the run is cancelled first; returns true when the event actually fires.