Enum Parallel

pub enum Parallel {
    Opening {
        id: String,
        job_channel: Sender<Message>,
        position: usize,
    },
    Closing {
        id: String,
        job_channel: Sender<Message>,
        position: usize,
        dependencies: AtomicUsize,
        dependencies_met: AtomicUsize,
    },
}

Parallel node concrete type

Contains two variants, Opening and Closing, this is because each one behaves in a different way when run. The Closing variant of a parallel must hold execution until all pointers into it have been resolved whereas an Opening variant does nothing.

Variants

Opening

No special behaviour required for Opening, simply completes with no bespoke behaviour

Fields

id: String

job_channel: Sender<Message>

position: usize

Closing

Keeps track of how many times it is pointed to and how many times it has been run. We can only proceed once it has been run as many times as it has pointers to it. The dependencies_met count is reset every time the node completes, this is in case we loop back to this node

Fields

id: String

job_channel: Sender<Message>

position: usize

dependencies: AtomicUsize

How many times it is pointed to

dependencies_met: AtomicUsize

How many times it has been run

Trait Implementations

impl Debug for Parallel

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

Formats the value using the given formatter.

impl Node for Parallel

fn kind(&self) -> WorkflowNodeType

Return the type of node, this is used for easily locating the Start and End nodes

fn id(&self) -> &str

The current node ID, used by the Job struct to know the current node

fn position(&self) -> usize

A pointer to the current nodes position in the Job.nodes collection

fn run<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), NodeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

The publicly exposed API for running a node

fn execute<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Parameter>, NodeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

The instructions for how to execute each node

fn create_msg<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Message> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create message to be sent to the executor once the node has been executed