Skip to main content

WorkflowContext

Struct WorkflowContext 

Source
pub struct WorkflowContext {
    pub branch_id: String,
    pub config: Value,
    pub instance_metadata: Value,
    pub state: Arc<dyn State>,
    pub recorder: Arc<dyn RunRecorder>,
    pub trigger_kind: String,
}
Expand description

The execution context handed to every step node.

Port of the subset of WorkflowContext a node legitimately touches: branch id (for state scoping), instance config + metadata (for template resolution), and the state handle. I/O tool calls (ctx.do(...)) are the next porting phase.

Fields§

§branch_id: String

Workflow branch this record belongs to.

§config: Value

Configuration object validated against the declared schema.

§instance_metadata: Value

Instance metadata available to templates.

§state: Arc<dyn State>

Branch-scoped durable state handle.

§recorder: Arc<dyn RunRecorder>

Run recorder receiving step facts.

§trigger_kind: String

Kind of trigger that started the run.

Implementations§

Source§

impl WorkflowContext

Source

pub fn new(branch_id: impl Into<String>, state: Arc<dyn State>) -> Self

Context for branch_id over state with a no-op recorder.

Source

pub fn with_config(self, config: Value) -> Self

Attach instance config.

Source

pub fn with_recorder(self, recorder: Arc<dyn RunRecorder>) -> Self

Attach a recorder.

Source

pub fn with_trigger_kind(self, trigger_kind: impl Into<String>) -> Self

Set the trigger kind.

Source

pub fn scoped(&self, key: &str) -> String

Prefix a state key with the branch id (R6 scoping).

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more