Skip to main content

Command

Struct Command 

Source
pub struct Command<S: State> {
    pub update: Option<S::Update>,
    pub goto: Goto,
    pub graph: GraphTarget,
    pub resume: Option<ResumeValue>,
    pub stream_data: Vec<Value>,
}
Expand description

Command: node return value combining state update and routing

Nodes can return S::Update (simple case) or Command<S> (for routing control).

Fields§

§update: Option<S::Update>

State update to apply

§goto: Goto

Routing instruction

§graph: GraphTarget

Target graph (current or parent)

§resume: Option<ResumeValue>

Resume value for HITL interrupt resumption

When provided, this value is used to resume from a previously triggered interrupt. Supports single values, ID-based mapping, and namespace-based mapping via ResumeValue.

§stream_data: Vec<Value>

Custom streaming data to emit during execution

Nodes can attach arbitrary JSON values here that will be emitted as [StreamEvent::Custom] events during graph execution. Each entry in the vector produces one custom stream event tagged with the emitting node name. Use Command::with_stream_data to append items.

Implementations§

Source§

impl<S: State> Command<S>

Source

pub const fn update(update: S::Update) -> Self

Create command with only state update

Source

pub fn goto(target: impl Into<String>) -> Self

Create command with only routing

Source

pub fn update_and_goto(update: S::Update, target: impl Into<String>) -> Self

Create command with update and routing

Source

pub const fn send(targets: Vec<SendTarget>) -> Self

Create command with dynamic fan-out

Source

pub const fn update_and_send( update: S::Update, targets: Vec<SendTarget>, ) -> Self

Create command with update and fan-out

Source

pub const fn end() -> Self

Create command that terminates current path

Source

pub fn goto_parent(target: impl Into<String>) -> Self

Create command that routes to parent graph

Source

pub fn with_resume(self, value: ResumeValue) -> Self

Attach a resume value to this command

Source

pub fn with_stream_data(self, data: Value) -> Self

Attach custom streaming data to this command

The given value is appended to the command’s streaming data list. During graph execution, each entry is emitted as a [StreamEvent::Custom] event, allowing nodes to push custom JSON payloads to the stream consumer alongside state updates and routing.

§Examples
use juncture_core::Command;
use serde_json::json;

// In a node returning Command:
Command::end().with_stream_data(json!({"progress": 0.75}));

Trait Implementations§

Source§

impl<S: Clone + State> Clone for Command<S>
where S::Update: Clone,

Source§

fn clone(&self) -> Command<S>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S: Debug + State> Debug for Command<S>
where S::Update: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S: State> Default for Command<S>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<S> Freeze for Command<S>
where <S as State>::Update: Freeze,

§

impl<S> RefUnwindSafe for Command<S>
where <S as State>::Update: RefUnwindSafe,

§

impl<S> Send for Command<S>

§

impl<S> Sync for Command<S>

§

impl<S> Unpin for Command<S>
where <S as State>::Update: Unpin,

§

impl<S> UnsafeUnpin for Command<S>
where <S as State>::Update: UnsafeUnpin,

§

impl<S> UnwindSafe for Command<S>
where <S as State>::Update: UnwindSafe,

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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