Skip to main content

Command

Struct Command 

Source
pub struct Command<S: GraphState> { /* private fields */ }
Expand description

Fluent builder for what a node returns: state delta + routing + optional payload.

Implementations§

Source§

impl<S: GraphState> Command<S>

Source

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

Build a Command with a state delta. Default routing is Goto::End.

Source

pub fn goto_only(goto: Goto) -> Self
where S::Update: Default,

Build with default state delta and a custom goto.

Source

pub fn goto(self, name: impl Into<String>) -> Self

Route to a single named node.

Source

pub fn goto_multiple<I, N>(self, names: I) -> Self
where I: IntoIterator<Item = N>, N: Into<String>,

Fan out to multiple named nodes.

Source

pub fn send<I, N>(self, targets: I) -> Self
where I: IntoIterator<Item = (N, Value)>, N: Into<String>,

Dispatch with per-target payloads (Goto::Send).

Source

pub fn end(self) -> Self

Terminate the graph.

Source

pub fn with_payload(self, payload: Value) -> Self

Attach a payload. If the goto is a single-target Goto::Node, this promotes it to Goto::Send so the receiving node can read the payload. On Goto::End the payload is dropped.

Trait Implementations§

Source§

impl<S: Clone + GraphState> 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 + GraphState> 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: GraphState> From<Command<S>> for NodeOut<S>

Source§

fn from(c: Command<S>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

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

§

impl<S> RefUnwindSafe for Command<S>

§

impl<S> Send for Command<S>

§

impl<S> Sync for Command<S>
where <S as GraphState>::Update: Sync,

§

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

§

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

§

impl<S> UnwindSafe for Command<S>
where <S as GraphState>::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<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