Struct boomerang::builder::EnvBuilder

pub struct EnvBuilder { /* private fields */ }

Implementations

impl EnvBuilder

pub fn new() -> Self

pub fn add_reactor<S: ReactorState>( &mut self, name: &str, parent: Option<BuilderReactorKey>, reactor: S ) -> ReactorBuilderState<'_>

Add a new Reactor

• name: Instance name of the reactor

pub fn add_port<T: PortData>( &mut self, name: &str, port_type: PortType, reactor_key: BuilderReactorKey ) -> Result<TypedPortKey<T>, BuilderError>

pub fn add_startup_action( &mut self, name: &str, reactor_key: BuilderReactorKey ) -> Result<TypedActionKey, BuilderError>

pub fn add_shutdown_action( &mut self, name: &str, reactor_key: BuilderReactorKey ) -> Result<TypedActionKey, BuilderError>

pub fn add_logical_action<T: ActionData>( &mut self, name: &str, min_delay: Option<Duration>, reactor_key: BuilderReactorKey ) -> Result<TypedActionKey<T, Logical>, BuilderError>

pub fn add_physical_action<T: ActionData>( &mut self, name: &str, min_delay: Option<Duration>, reactor_key: BuilderReactorKey ) -> Result<TypedActionKey<T, Physical>, BuilderError>

pub fn add_reaction( &mut self, name: &str, reactor_key: BuilderReactorKey, reaction_fn: Box<dyn ReactionFn> ) -> ReactionBuilderState<'_>

Add a Reaction to a given Reactor

pub fn add_action<T, Q, F>( &mut self, name: &str, ty: ActionType, reactor_key: BuilderReactorKey, action_fn: F ) -> Result<TypedActionKey<T, Q>, BuilderError>where T: PortData, F: ActionBuilderFn + 'static,

Add an Action to a given Reactor using closure F

pub fn get_port( &self, port_name: &str, reactor_key: BuilderReactorKey ) -> Result<BuilderPortKey, BuilderError>

Find a Port matching a given name and ReactorKey

pub fn find_action_by_name( &self, action_name: &str, reactor_key: BuilderReactorKey ) -> Result<BuilderActionKey, BuilderError>

Find an Action matching a given name and ReactorKey

pub fn bind_port<T: PortData>( &mut self, port_a_key: TypedPortKey<T>, port_b_key: TypedPortKey<T> ) -> Result<(), BuilderError>

Bind Port A to Port B The nominal case is to bind Input A to Output B

pub fn action_fqn( &self, action_key: BuilderActionKey ) -> Result<String, BuilderError>

Get a fully-qualified string name for the given ActionKey

pub fn reactor_fqn( &self, reactor_key: BuilderReactorKey ) -> Result<String, BuilderError>

Get a fully-qualified string for the given ReactionKey

pub fn reaction_fqn( &self, reaction_key: BuilderReactionKey ) -> Result<String, BuilderError>

Get a fully-qualified string for the given ReactionKey

pub fn port_fqn(&self, port_key: BuilderPortKey) -> Result<String, BuilderError>

Get a fully-qualified string for the given PortKey

pub fn follow_port_inward_binding( &self, port_key: BuilderPortKey ) -> BuilderPortKey

Follow the inward_binding’s of Ports to the source

pub fn reaction_dependency_edges( &self ) -> impl Iterator<Item = (BuilderReactionKey, BuilderReactionKey)> + '_

Build an iterator of all Reaction dependency edges in the graph

pub fn build_reaction_graph(&self) -> DiGraphMap<BuilderReactionKey, ()>

Build a DAG of Reactions

pub fn build_reactor_graph(&self) -> DiGraphMap<BuilderReactorKey, ()>

Build a DAG of Reactors

pub fn build_runtime_level_map( &self ) -> Result<SecondaryMap<BuilderReactionKey, usize>, BuilderError>

Build a Mapping of BuilderReactionKey -> Level corresponding to the parallelizable schedule

This implements the Coffman-Graham algorithm for job scheduling. See https://en.m.wikipedia.org/wiki/Coffman%E2%80%93Graham_algorithm

Trait Implementations

impl Debug for EnvBuilder

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

Formats the value using the given formatter.

impl Default for EnvBuilder

fn default() -> EnvBuilder

Returns the “default value” for a type.

impl TryInto<Env> for EnvBuilder

type Error = BuilderError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Env, Self::Error>

Performs the conversion.