Struct CuConfig

Source
pub struct CuConfig {
    pub monitor: Option<MonitorConfig>,
    pub logging: Option<LoggingConfig>,
    pub graphs: ConfigGraphs,
}
Expand description

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

The core of CuConfig is its graphs field which can be either a simple graph or a collection of mission-specific graphs. The graph structure is based on petgraph.

Fields§

§monitor: Option<MonitorConfig>

Optional monitoring configuration

§logging: Option<LoggingConfig>

Optional logging configuration

§graphs: ConfigGraphs

Graph structure - either a single graph or multiple mission-specific graphs

Implementations§

Source§

impl CuConfig

The implementation has a lot of convenience methods to manipulate the configuration to give some flexibility into programmatically creating the configuration.

Source

pub fn new_simple_type() -> CuConfig

Source

pub fn new_mission_type() -> CuConfig

Source

pub fn serialize_ron(&self) -> String

Source

pub fn deserialize_ron(ron: &str) -> CuConfig

Source

pub fn render( &self, output: &mut dyn Write, mission_id: Option<&str>, ) -> Result<(), CuError>

Render the configuration graph in the dot format.

Source

pub fn get_all_instances_configs( &self, mission_id: Option<&str>, ) -> Vec<Option<&ComponentConfig>>

Source

pub fn get_graph(&self, mission_id: Option<&str>) -> Result<&CuGraph, CuError>

Source

pub fn get_graph_mut( &mut self, mission_id: Option<&str>, ) -> Result<&mut CuGraph, CuError>

Source

pub fn get_monitor_config(&self) -> Option<&MonitorConfig>

Source

pub fn validate_logging_config(&self) -> Result<(), CuError>

Validate the logging configuration to ensure section pre-allocation sizes do not exceed slab sizes. This method is wrapper around LoggingConfig::validate

Trait Implementations§

Source§

impl Clone for CuConfig

Source§

fn clone(&self) -> CuConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CuConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CuConfig

Source§

fn default() -> CuConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CuConfig

Source§

fn deserialize<D>( deserializer: D, ) -> Result<CuConfig, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

This is a custom serialization to make this implementation independent of petgraph.

Source§

impl Serialize for CuConfig

Source§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

This is a custom serialization to make this implementation independent of petgraph.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> EncodableKey for T
where T: Serialize,

§

fn to_bytes(&self) -> Result<Vec<u8>, DataError>

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,