Struct NodeConfig 

pub struct NodeConfig {
    pub blackboard: Blackboard,
    pub input_ports: PortsRemapping,
    pub output_ports: PortsRemapping,
    pub manifest: Option<Arc<TreeNodeManifest>>,
    pub uid: u16,
    pub path: String,
    /* private fields */
}

Contains all common configuration that all types of nodes use.

Fields

blackboard: Blackboard

input_ports: PortsRemapping

output_ports: PortsRemapping

manifest: Option<Arc<TreeNodeManifest>>

uid: u16

path: String

TODO: doesn’t show actual path yet

Implementations

impl NodeConfig

pub fn new(blackboard: Blackboard) -> NodeConfig

pub fn blackboard(&self) -> &Blackboard

Returns a reference to the blackboard.

pub fn add_port( &mut self, direction: PortDirection, name: String, value: String, )

Adds a port to the config based on the direction. Used during XML parsing.

pub fn has_port(&self, direction: &PortDirection, name: &String) -> bool

pub fn manifest(&self) -> Result<Arc<TreeNodeManifest>, ParseError>

Returns a pointer to the TreeNodeManifest for this node. Only used during XML parsing.

pub fn set_manifest(&mut self, manifest: Arc<TreeNodeManifest>)

Replace the inner manifest.

pub fn get_input<T>(&mut self, port: &str) -> Result<T, NodeError>

where T: FromString + Clone + Send + 'static,

Returns the value of the input port at the port key as a Result<T, NodeError>. The value is Err in the following situations:

• The port wasn’t found at that key
• T doesn’t match the type of the stored value
• If a default value is needed (value is empty), couldn’t parse default value
• If a remapped key (e.g. a port value of "{foo}" references the blackboard key "foo"), blackboard entry wasn’t found or couldn’t be read as T
• If port value is a string, couldn’t convert it to T using parse_str().

pub async fn set_output<T>( &mut self, port: &str, value: T, ) -> Result<(), NodeError>

where T: Clone + Send + 'static,

Sets value into the blackboard. The key is based on the value provided to the port at port.

Examples

• Port value: "=": uses the port name as the blackboard key
• "foo" uses "foo" as the blackboard key
• "{foo}" uses "foo" as the blackboard key

pub async fn set_output_sync<T>( &mut self, port: &str, value: T, ) -> Result<(), NodeError>

where T: Clone + Send + 'static,

Sync version of set_output<T>

Sets value into the blackboard. The key is based on the value provided to the port at port.

Examples

• Port value: "=": uses the port name as the blackboard key
• "foo" uses "foo" as the blackboard key
• "{foo}" uses "foo" as the blackboard key

Trait Implementations

impl Clone for NodeConfig

fn clone(&self) -> NodeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeConfig

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

Formats the value using the given formatter.