Struct Flow 

pub struct Flow {
    pub schema_version: String,
    pub id: FlowId,
    pub kind: FlowKind,
    pub entrypoints: BTreeMap<String, Value>,
    pub nodes: IndexMap<NodeId, Node, FlowHasher>,
    pub metadata: FlowMetadata,
}

Canonical flow representation embedded in packs.

Fields

schema_version: String

Schema version for the flow document.

id: FlowId

Flow identifier inside the pack.

kind: FlowKind

Flow execution kind.

entrypoints: BTreeMap<String, Value>

Entrypoints for this flow keyed by name (for example default, telegram, http:/path).

nodes: IndexMap<NodeId, Node, FlowHasher>

Ordered node map describing the flow graph.

metadata: FlowMetadata

Optional metadata for authoring/UX.

Implementations

impl Flow

pub fn is_empty(&self) -> bool

Returns true when no nodes are defined.

pub fn ingress(&self) -> Option<(&NodeId, &Node)>

Returns the implicit ingress node (first user-declared entry).

Trait Implementations

impl Clone for Flow

fn clone(&self) -> Flow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Flow

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Flow

fn eq(&self, other: &Flow) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Flow

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Flow