Module config 

This module defines the configuration of the copper runtime. The configuration is a directed graph where nodes are tasks and edges are connections between tasks. The configuration is serialized in the RON format. The configuration is used to generate the runtime code at compile time.

Re-exports

pub use petgraph::Direction::Incoming;

pub use petgraph::Direction::Outgoing;

Modules

imp 🔒

Macros

impl_from_numeric_for_value 🔒

impl_from_value_for_int 🔒

impl_try_from_value_for_int 🔒

Structs

BridgeConfig

Declarative definition of a bridge component with a list of channels.

Cnx

This represents a connection between 2 tasks (nodes) in the configuration graph.

ComponentConfig

This is the configuration of a component (like a task config or a monitoring config):w It is a map of key-value pairs. It is given to the new method of the task implementation.

ConfigError

CuConfig

CuConfig is the programmatic representation of the configuration graph. It is a directed graph where nodes are tasks and edges are connections between tasks.

CuConfigRepresentation 🔒

This is the main Copper configuration representation.

CuGraph

IncludesConfig

Includes are used to include other configuration files.

InstanceConfigOverridesRepresentation 🔒

InstanceConfigSetOperation

One path-based config overlay applied to a parsed local Copper config.

LoggingCodecSpec

LoggingConfig

MissionsConfig

Missions are used to generate alternative DAGs within the same configuration.

MonitorConfig

MultiCopperChannelContract 🔒

MultiCopperConfig

Strict umbrella configuration describing multiple Copper subsystems and their explicit links.

MultiCopperConfigRepresentation 🔒

MultiCopperEndpoint

Typed endpoint reference used by validated multi-Copper interconnects.

MultiCopperInterconnect

Validated explicit interconnect between two subsystem endpoints.

MultiCopperInterconnectConfig

One explicit interconnect between two subsystem bridge channels.

MultiCopperSubsystem

Validated subsystem entry with its compiler-assigned numeric subsystem code and parsed local Copper config.

MultiCopperSubsystemConfig

One subsystem participating in a multi-Copper deployment.

Node

A node in the configuration graph. A node represents a Task in the system Graph.

NodeLogging

Configuration for logging in the node.

PortLookup 🔒

RenderConnection 🔒

RenderNode 🔒

RenderSection 🔒

RenderTopology 🔒

ResourceBundleConfig

Declarative definition of a resource bundle.

RuntimeConfig

SerializedCnx 🔒

Serialized representation of a connection used for the RON config.

Value

Wrapper around the ron::Value to allow for custom serialization.

Enums

BridgeChannelConfigRepresentation

Directional mapping for bridge channels.

ConfigGraphs

CuDirection

A simple wrapper enum for petgraph::Direction, designed to be converted into it via the From trait.

EndpointRole 🔒

Flavor

Distinguishes regular tasks from bridge nodes so downstream stages can apply bridge-specific instantiation rules.

InstanceConfigTargetKind 🔒

MultiCopperChannelDirection 🔒

OneOrManyMonitorConfig 🔒

Constants

DEFAULT_KEYFRAME_INTERVAL

DEFAULT_MISSION_ID

MAX_RATE_TARGET_HZ

Maximum representable Copper runtime rate target in whole Hertz.

NC_ENDPOINT

Special destination endpoint used to mark an output as intentionally not connected.

Functions

apply_bridge_node_config_override_to_graph 🔒

apply_instance_config_set_operation 🔒

apply_instance_overrides 🔒

apply_instance_overrides_from_file 🔒

apply_task_config_override_to_graph 🔒

build_bridge_lookup 🔒

build_config_table 🔒

build_multi_bridge_channel_contracts 🔒

build_port_table 🔒

build_render_topology 🔒

config_representation_to_config 🔒

Convert a CuConfigRepresentation to a CuConfig. Uses the deserialize_impl method and validates the logging configuration.

default_as_true 🔒

default_keyframe_interval 🔒

deserialize_config_representation 🔒

Shared implementation for deserializing a CuConfigRepresentation into a CuConfig

deserialize_monitor_configs 🔒

escape_dot_id 🔒

format_endpoint 🔒

insert_bridge_node 🔒

merge_component_config 🔒

merge_connection_missions 🔒

mission_applies 🔒

multi_channel_key 🔒

parse_config_string 🔒

Read a copper configuration from a String. Parse a RON string into a CuConfigRepresentation, using the standard options. Returns an error if the parsing fails.

parse_endpoint 🔒

parse_instance_config_overrides_string 🔒

parse_instance_override_target 🔒

parse_multi_config_string 🔒

parse_multi_endpoint 🔒

process_includes 🔒

Returns a merged CuConfigRepresentation.

read_configuration

Read a copper configuration from a file.

read_configuration_str

read_multi_configuration

Read a strict multi-Copper umbrella configuration from a file.

read_multi_configuration_str

Read a strict multi-Copper umbrella configuration from a string.

register_multi_channel_msg 🔒

register_nc_output 🔒

resolve_relative_config_path 🔒

ron_value_to_cu_value 🔒

sanitize_identifier 🔒

substitute_parameters 🔒

validate_bridge_channel 🔒

validate_multi_config_representation 🔒

Type Aliases

NodeId

NodeId is the unique identifier of a node in the configuration graph for petgraph and the code generation.