Struct flowclib::model::flow::Flow

pub struct Flow {
    pub name: Name,
    pub inputs: IOSet,
    pub outputs: IOSet,
    pub process_refs: Vec<ProcessReference>,
    pub connections: Vec<Connection>,
    pub metadata: MetaData,
    pub alias: Name,
    pub id: usize,
    pub source_url: Url,
    pub route: Route,
    pub subprocesses: HashMap<Name, Process>,
    pub lib_references: HashSet<Url>,
    /* private fields */
}

Flow defines a parent or child flow in the nested flow hierarchy

Fields

name: Name

name given to this flow

inputs: IOSet

inputs that this flow defines

outputs: IOSet

outputs that this flow defines

process_refs: Vec<ProcessReference>

Set of sub-processes referenced (used) in this flow

connections: Vec<Connection>

connections within this flow, from flow input or to flow outputs

metadata: MetaData

metadata about flow author, versions etc

alias: Name

When the same process is used multiple times within a single flow, to disambiguate between them each one must be given an alias that is used to refer to it

id: usize

flows are assigned a numeric id in the hierarchy

source_url: Url

source_url is the url of the file/resource where this flow definition was read from

route: Route

route defines the location in the hierarchy of flows where this ones resides

subprocesses: HashMap<Name, Process>

subprocesses are the loaded definition of the processes reference (used) within this flow

lib_references: HashSet<Url>

lib_references is the set of library references used in this flow

Implementations

impl Flow

pub fn default_url() -> Url

Return a default value for a Url as part of a flow

pub fn set_alias(&mut self, alias: &Name)

Set the alias of this flow to the supplied Name

pub fn get_docs(&self) -> &str

Get the name of any associated docs file

pub fn inputs(&self) -> &IOSet

Get a reference to the set of inputs this flow defines

pub fn inputs_mut(&mut self) -> &mut IOSet

Get a mutable reference to the set of inputs this flow defines

pub fn outputs(&self) -> &IOSet

Get a reference to the set of outputs this flow defines

pub fn config(
    &mut self,
    source_url: &Url,
    parent_route: &Route,
    alias_from_reference: &Name,
    id: usize,
    initializations: &HashMap<String, InputInitializer>
) -> Result<()>

Configure a flow with additional information after it is deserialized from file

pub fn build_connections(&mut self, level: usize) -> Result<()>

Iterate over all the connections defined in the flow, and attempt to connect the source and destination, checking the types are compatible

Trait Implementations

impl Clone for Flow

fn clone(&self) -> Flow

Returns a copy 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 Default for Flow

fn default() -> Flow

Returns the “default value” for a type.

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 Display for Flow

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

Formats the value using the given formatter.

impl From<&'_ Flow> for MetaData

fn from(flow: &Flow) -> Self

Performs the conversion.

impl HasName for Flow

fn name(&self) -> &Name

Return a reference to the name of the struct implementing this trait

fn alias(&self) -> &Name

Return a reference to the alias (also a Name type) of the struct implementing this trait

impl HasRoute for Flow

fn route(&self) -> &Route

Return a reference to the Route of the struct that implements this trait

fn route_mut(&mut self) -> &mut Route

Return a mutable reference to the Route of the struct that implements this trait

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 SetRoute for Flow

fn set_routes_from_parent(&mut self, parent_route: &Route)

Set the routes in fields of this struct based on the route of it’s parent.

impl Validate for Flow

fn validate(&self) -> Result<()>

Validate that a deserialized model data structure is valid for use