Struct flowcore::model::runtime_function::RuntimeFunction

pub struct RuntimeFunction { /* private fields */ }

RuntimeFunction contains all the information needed about a function and its implementation to be able to execute a flow using it.

Implementations

impl RuntimeFunction

pub fn new<I: Into<String>>( implementation_location: I, inputs: Vec<Input>, id: usize, flow_id: usize, output_connections: &[OutputConnection], include_destination_routes: bool ) -> Self

Create a new RuntimeFunction with the specified name, route, implementation etc. This only needs to be used by compilers or IDE generating manifests with functions The library flowrlib just deserializes them from the manifest The Vector of outputs: Output sub-path (or “”), destination function id, destination function io number, Optional path of destination

pub fn id(&self) -> usize

Accessor for a RuntimeFunction id

pub fn get_flow_id(&self) -> usize

Accessor for a RuntimeFunction flow_id

pub fn init(&mut self)

Initialize the function to be ready to be called during flow execution

pub fn init_inputs(&mut self, first_time: bool, flow_idle: bool)

Initialize Inputs that have InputInitializers on them

pub fn implementation_location(&self) -> &str

Accessor for a RuntimeFunction implementation_location

pub fn send(&mut self, io_number: usize, value: Value) -> bool

Send a value or array of values to the specified input of this function

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

Accessor for a RuntimeFunction output_connections field

pub fn get_implementation_location(&self) -> &str

Get a reference to the implementation_location

pub fn set_implementation_url(&mut self, manifest_url: &Url) -> Result<()>

Set the implementation_location, as an absolute Url relative to the manifest_url

pub fn get_implementation_url(&self) -> &Url

Get a reference to the implementation_url

pub fn values_available(&self, input_number: usize) -> usize

Returns the number of values available on RuntimeFunction’s Input number input_number

pub fn input_sets_available(&self) -> usize

Returns how many jobs can be created for this function with the available inputs NOTE: For Impure functions without inputs (that can always run and produce a value) this will return 1 always

pub fn can_run(&self) -> bool

Can this function run? Either because: - it has input sets to allow it to run - it has no inputs and so can always run

pub fn inputs(&self) -> &Vec<Input>

Inspect the values of the inputs of a RuntimeFunction

pub fn take_input_set(&mut self) -> Option<Vec<Value>>

Read the values from the inputs and return them for use in executing the RuntimeFunction

pub fn is_always_ready(&self) -> bool

Will this function always be able to create new jobs no matter what // TODO make this an internal bool on creation!

Trait Implementations

impl Clone for RuntimeFunction

fn clone(&self) -> RuntimeFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RuntimeFunction

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

Deserialize this value from the given Serde deserializer.

impl PartialEq for RuntimeFunction

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for RuntimeFunction

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

Serialize this value into the given Serde serializer.

impl Eq for RuntimeFunction

impl StructuralEq for RuntimeFunction

impl StructuralPartialEq for RuntimeFunction