Struct flowclib::model::function::Function

pub struct Function { /* private fields */ }

Function defines a Function that implements some processing in the flow hierarchy

Implementations

impl Function

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

Configure a function with additional information after it is deserialized as part of a flow

pub fn set_id(&mut self, id: usize)

Set the id of this function

pub fn get_id(&self) -> usize

Get the id of this function

pub fn get_docs(&self) -> &str

Get the name of any associated docs file

pub fn get_flow_id(&self) -> usize

Get the id of the low this function is a part of

pub fn is_impure(&self) -> bool

Return true if this function is impure or not

pub fn get_inputs(&self) -> &IOSet

Get a reference to the set of inputs of this function

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

Get a mutable reference to the set of inputs of this function

pub fn get_outputs(&self) -> IOSet

Get a reference to the set of outputs this function generates

pub fn add_output_route(&mut self, output_route: OutputConnection)

Add a connection from this function to another

pub fn get_output_connections(&self) -> &Vec<OutputConnection>

Get a reference to the set of output connections from this function to others

pub fn get_implementation(&self) -> &str

Get a reference to the implementation of this function

pub fn set_implementation(&mut self, implementation: &str)

Set the implementation location of this function

pub fn get_source_url(&self) -> &Url

Get the source url for the file where this function was defined

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

Get the lib reference of this function

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Default for Function

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Function

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Function

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

Formats the value using the given formatter.

impl HasName for Function

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 Function

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 Function

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 Function

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 Function

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

Validate that a deserialized model data structure is valid for use