Struct origen::FLOW

pub struct FLOW { /* fields omitted */ }

This is analogous to the TEST for test program duration, it provides a similar API for pushing nodes to the current flow, FLOW.push(my_node), etc.

Methods from Deref<Target = FlowManager>

pub fn selected(&self) -> Option<String>

pub fn select(&self, name: &str) -> Result<()>

Select the given flow such that the majority of FlowManager methods will act on it. Returns an error if no flow of the given name exists.

pub fn select_current(&self)

De-selects any named flow selection made via the select() method, returning the majority of the FlowManager methods to act on the current/latest flow

pub fn with_all_flows<T, F>(&self, func: F) -> Result<T> where
    F: FnMut(&IndexMap<String, AST>) -> Result<T>, 

Execute the given function with an immutable reference to an index map containing all flows, the map will simply be empty if there are no flows. The result of the given function is returned.

pub fn with_selected_flow<T, F>(&self, func: F) -> Result<T> where
    F: FnOnce(&AST) -> Result<T>, 

Execute the given function which receives the currently selected flow (or the current flow if none is selected) as an input, returning the result of the function or an error if no flow exists yet

pub fn with_selected_flow_mut<T, F>(&self, func: F) -> Result<T> where
    F: FnOnce(&mut AST) -> Result<T>, 

Like with_selected_flow() but with a mutable reference to the flow AST

pub fn start(&self, name: &str) -> Result<()>

Starts a new flow, returns an error if a flow with the same name already exists.

pub fn end(&self) -> Result<()>

End the current flow

pub fn push(&self, node: Node) -> Result<()>

Push a new terminal node into the AST for the current flow

pub fn append(&self, nodes: &mut Vec<Node>) -> Result<()>

pub fn push_and_open(&self, node: Node) -> Result<usize>

Push a new node into the current flow AST and leave it open, meaning that all new nodes added to the AST will be inserted as children of this node until it is closed. A reference ID is returned and the caller should save this and provide it again when calling close(). If the reference does not match the expected an error will be raised. This will catch any cases of application code forgetting to close a node before closing one of its parents.

pub fn close(&self, ref_id: usize) -> Result<()>

Close the currently open node

pub fn replace(&self, node: Node, offset: usize) -> Result<()>

Replace the node n - offset with the given node, use offset = 0 to replace the last node that was pushed. Fails if the AST has no children yet or if the offset is otherwise out of range.

pub fn get(&self, offset: usize) -> Result<Node>

Returns a copy of node n - offset, an offset of 0 means the last node pushed. Fails if the offset is out of range.

pub fn get_with_descendants(&self, offset: usize) -> Result<Node>

Returns a copy of node n - offset, where an offset of 0 means the last node pushed. Differs from ‘get’ in that the offset will step into all nodes’ children. For example, in the AST: n1 n2 n2.1 n2.2 n3 offset | get(offset) | get_with_descendants(offset) 0 | n3 | n3 1 | n2 | n2.2 2 | n1 | n2.1

Fails if the offset is out of range.

pub fn insert(&self, node: Node, offset: usize) -> Result<()>

Insert the node at position n - offset, using offset = 0 is equivalent calling push().

pub fn to_string(&self) -> String

pub fn process(
    &self,
    process_fn: &mut dyn FnMut(&Node) -> Result<Node>
) -> Result<Node>

pub fn to_node(&self) -> Node

Returns a copy of the current flow as a Node

pub fn to_pickle(&self) -> Vec<u8>

Serializes the current flow AST for import into Python

Trait Implementations

impl Deref for FLOW

type Target = FlowManager

The resulting type after dereferencing.

fn deref(&self) -> &FlowManager

Dereferences the value.

impl LazyStatic for FLOW

fn initialize(lazy: &Self)