From 3a01b3ef5242414a0b4eaa85ed338b519af5c4ab Mon Sep 17 00:00:00 2001 From: gbin Date: Fri, 10 Jan 2025 21:25:44 +0000 Subject: [PATCH] deploy: 80204ef88c71748c800e8d7318536371c6b523c2 --- cu29/config/struct.Cnx.html | 2 +- cu29/config/struct.CuConfig.html | 2 +- cu29/curuntime/fn.compute_runtime_plan.html | 4 ++-- cu29/curuntime/index.html | 2 +- cu29/cutask/index.html | 4 ++-- cu29/cutask/struct.CuMsgMetadata.html | 2 +- cu29/cutask/trait.CuSrcTask.html | 4 ++-- cu29/cutask/trait.Freezable.html | 4 ++-- cu29/prelude/attr.copper_runtime.html | 4 ++-- cu29/prelude/config/struct.Cnx.html | 2 +- cu29/prelude/config/struct.CuConfig.html | 2 +- cu29/prelude/curuntime/fn.compute_runtime_plan.html | 4 ++-- cu29/prelude/curuntime/index.html | 2 +- cu29/prelude/cutask/index.html | 4 ++-- cu29/prelude/cutask/struct.CuMsgMetadata.html | 2 +- cu29/prelude/cutask/trait.CuSrcTask.html | 4 ++-- cu29/prelude/cutask/trait.Freezable.html | 4 ++-- cu29/prelude/fn.compute_runtime_plan.html | 4 ++-- cu29/prelude/index.html | 10 +++++----- cu29/prelude/macro.debug.html | 2 +- cu29/prelude/struct.Cnx.html | 2 +- cu29/prelude/struct.CuConfig.html | 2 +- cu29/prelude/struct.CuMsgMetadata.html | 2 +- cu29/prelude/struct.UnifiedLoggerIOReader.html | 2 +- cu29/prelude/trait.CuSrcTask.html | 4 ++-- cu29/prelude/trait.Freezable.html | 4 ++-- cu29_derive/attr.copper_runtime.html | 4 ++-- cu29_derive/index.html | 2 +- cu29_log_derive/macro.debug.html | 2 +- cu29_rendercfg/config/struct.Cnx.html | 2 +- cu29_rendercfg/config/struct.CuConfig.html | 2 +- cu29_runtime/config/struct.Cnx.html | 2 +- cu29_runtime/config/struct.CuConfig.html | 2 +- cu29_runtime/curuntime/fn.compute_runtime_plan.html | 4 ++-- cu29_runtime/curuntime/index.html | 2 +- cu29_runtime/cutask/index.html | 4 ++-- cu29_runtime/cutask/struct.CuMsgMetadata.html | 2 +- cu29_runtime/cutask/trait.CuSrcTask.html | 4 ++-- cu29_runtime/cutask/trait.Freezable.html | 4 ++-- cu29_unifiedlog/index.html | 2 +- cu29_unifiedlog/struct.UnifiedLoggerIOReader.html | 2 +- help.html | 2 +- search.desc/cu29/cu29-desc-0-.js | 2 +- search.desc/cu29_rendercfg/cu29_rendercfg-desc-0-.js | 2 +- search.desc/cu29_runtime/cu29_runtime-desc-0-.js | 2 +- search.desc/cu29_unifiedlog/cu29_unifiedlog-desc-0-.js | 2 +- settings.html | 2 +- src/cu29_clock/lib.rs.html | 2 +- src/cu29_derive/lib.rs.html | 8 ++++---- src/cu29_log_derive/lib.rs.html | 2 +- src/cu29_rendercfg/config.rs.html | 4 ++-- src/cu29_runtime/config.rs.html | 4 ++-- src/cu29_runtime/curuntime.rs.html | 4 ++-- src/cu29_runtime/cutask.rs.html | 10 +++++----- src/cu29_traits/lib.rs.html | 2 +- src/cu29_unifiedlog/lib.rs.html | 4 ++-- 56 files changed, 88 insertions(+), 88 deletions(-) diff --git a/cu29/config/struct.Cnx.html b/cu29/config/struct.Cnx.html index 8a28b8d12..dc8117a29 100644 --- a/cu29/config/struct.Cnx.html +++ b/cu29/config/struct.Cnx.html @@ -4,7 +4,7 @@ pub store: Option<bool>, /* private fields */ }
Expand description

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

-

Fields§

§msg: String

Message type exchanged betwee src and dst.

+

Fields§

§msg: String

Message type exchanged between src and dst.

§batch: Option<u32>

Tells Copper to batch messages before sending the buffer to the next node. If None, Copper will just send 1 message at a time. If Some(n), Copper will batch n messages before sending the buffer.

diff --git a/cu29/config/struct.CuConfig.html b/cu29/config/struct.CuConfig.html index a5c825920..153ccbf1d 100644 --- a/cu29/config/struct.CuConfig.html +++ b/cu29/config/struct.CuConfig.html @@ -4,7 +4,7 @@ pub logging: Option<LoggingConfig>, }
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.

-

Fields§

§graph: StableGraph<Node, Cnx>§monitor: Option<MonitorConfig>§logging: Option<LoggingConfig>

Implementations§

Source§

impl CuConfig

The implementation has a lot of conveinence methods to manipulate +

Fields§

§graph: StableGraph<Node, Cnx>§monitor: Option<MonitorConfig>§logging: Option<LoggingConfig>

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 add_node(&mut self, node: Node) -> u32

Add a new node to the configuration graph.

Source

pub fn get_node(&self, node_id: u32) -> Option<&Node>

Get the node with the given id.

diff --git a/cu29/curuntime/fn.compute_runtime_plan.html b/cu29/curuntime/fn.compute_runtime_plan.html index 28f72dd3b..c450af9fb 100644 --- a/cu29/curuntime/fn.compute_runtime_plan.html +++ b/cu29/curuntime/fn.compute_runtime_plan.html @@ -1,5 +1,5 @@ -compute_runtime_plan in cu29::curuntime - Rust
cu29::curuntime

Function compute_runtime_plan

Source 
pub fn compute_runtime_plan(
+compute_runtime_plan in cu29::curuntime - Rust
cu29::curuntime
Function compute_runtime_plan
Source 
pub fn compute_runtime_plan(
     config: &CuConfig,
 ) -> Result<CuExecutionLoop, CuError>
Expand description
This is the main heuristics to compute an execution plan at compilation time.
-TODO: Make that heuristic plugable.

+TODO: Make that heuristic pluggable.

 

\ No newline at end of file
diff --git a/cu29/curuntime/index.html b/cu29/curuntime/index.html
index cf89ded99..c4a0a70ef 100644
--- a/cu29/curuntime/index.html
+++ b/cu29/curuntime/index.html
@@ -6,4 +6,4 @@
 if loop_count is None, the loop is infinite.
  • CuExecutionStep
    This structure represents a step in the execution plan.
  • CuRuntime
    This is the main structure that will be injected as a member of the Application struct. CT is the tuple of all the tasks in order of execution. CL is the type of the copper list, representing the input/output messages for all the tasks.

    • Enums§

    Functions§

    \ No newline at end of file +TODO: Make that heuristic pluggable.
  • find_task_type_for_id
    • \ No newline at end of file diff --git a/cu29/cutask/index.html b/cu29/cutask/index.html index bc2408a1e..8bb8a0ee9 100644 --- a/cu29/cutask/index.html +++ b/cu29/cutask/index.html @@ -3,5 +3,5 @@

    Structs§

    Traits§

    \ No newline at end of file +Note: A source has the privilege to have a clock passed to it vs a frozen clock.
  • CuTask
    This is the most generic Task of copper. It is a “transform” task deriving an output from an input.
  • Freezable
    The internal state of a task needs to be serializable +so the framework can take a snapshot of the task graph.
    • \ No newline at end of file diff --git a/cu29/cutask/struct.CuMsgMetadata.html b/cu29/cutask/struct.CuMsgMetadata.html index 1d50eb2c4..81fcc71d6 100644 --- a/cu29/cutask/struct.CuMsgMetadata.html +++ b/cu29/cutask/struct.CuMsgMetadata.html @@ -7,7 +7,7 @@ §tov: Tov

    The time of validity of the message. It can be undefined (None), one measure point or a range of measures (TimeRange).

    §status_txt: CuCompactString

    A small string for real time feedback purposes. -This is usefull for to display on the field when the tasks are operating correctly.

    +This is useful for to display on the field when the tasks are operating correctly.

    Implementations§

    Source§

    impl CuMsgMetadata

    Source

    pub fn set_status(&mut self, status: impl ToCompactString)

    Trait Implementations§

    Source§

    impl<'__de> BorrowDecode<'__de> for CuMsgMetadata

    Source§

    fn borrow_decode<__D>(decoder: &mut __D) -> Result<CuMsgMetadata, DecodeError>
    where __D: BorrowDecoder<'__de>,

    Attempt to decode this type with the given BorrowDecode.
    Source§

    impl Clone for CuMsgMetadata

    Source§

    fn clone(&self) -> CuMsgMetadata

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

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

    Performs copy-assignment from source. Read more
    Source§

    impl Debug for CuMsgMetadata

    Source§

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

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

    impl Decode for CuMsgMetadata

    Source§

    fn decode<__D>(decoder: &mut __D) -> Result<CuMsgMetadata, DecodeError>
    where __D: Decoder,

    Attempt to decode this type with the given Decode.
    Source§

    impl Default for CuMsgMetadata

    Source§

    fn default() -> CuMsgMetadata

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

    impl<'de> Deserialize<'de> for CuMsgMetadata

    Source§

    fn deserialize<__D>( diff --git a/cu29/cutask/trait.CuSrcTask.html b/cu29/cutask/trait.CuSrcTask.html index b0e2ae438..fe2ce2103 100644 --- a/cu29/cutask/trait.CuSrcTask.html +++ b/cu29/cutask/trait.CuSrcTask.html @@ -1,4 +1,4 @@ -CuSrcTask in cu29::cutask - Rust
    cu29::cutask

    Trait CuSrcTask

    Source 
    pub trait CuSrcTask<'cl>: Freezable {
+CuSrcTask in cu29::cutask - Rust
    cu29::cutask
    Trait CuSrcTask
    Source 
    pub trait CuSrcTask<'cl>: Freezable {
     type Output: CuMsgPack<'cl>;
 
     // Required methods
@@ -18,7 +18,7 @@
 }
    Expand description
    A Src Task is a task that only produces messages. For example drivers for sensors are Src Tasks.
 They are in push mode from the runtime.
 To set the frequency of the pulls and align them to any hw, see the runtime configuration.
-Note: A source has the priviledge to have a clock passed to it vs a frozen clock.
    
+Note: A source has the privilege to have a clock passed to it vs a frozen clock.
    
 
    Required Associated Types§
    Source
    type Output: CuMsgPack<'cl>
    Required Methods§
    Source
    fn new(_config: Option<&ComponentConfig>) -> Result<Self, CuError>
    where
     Self: Sized,
    Here you need to initialize everything your task will need for the duration of its lifetime.
 The config allows you to access the configuration of the task.
    
diff --git a/cu29/cutask/trait.Freezable.html b/cu29/cutask/trait.Freezable.html
index 02771fa89..a295c9c26 100644
--- a/cu29/cutask/trait.Freezable.html
+++ b/cu29/cutask/trait.Freezable.html
@@ -1,11 +1,11 @@
-Freezable in cu29::cutask - Rust
    cu29::cutask
    Trait Freezable
    Source 
    pub trait Freezable {
+Freezable in cu29::cutask - Rust
    cu29::cutask
    Trait Freezable
    Source 
    pub trait Freezable {
     // Provided methods
     fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>
        where E: Encoder { ... }
     fn thaw<D>(&mut self, decoder: &mut D) -> Result<(), DecodeError>
        where D: Decoder { ... }
 }
    Expand description
    The internal state of a task needs to be serializable
-so the framework can take a snapshop of the task graph.
    
+so the framework can take a snapshot of the task graph.
    
 
    Provided Methods§
    Source
    fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>
    where
     E: Encoder,
    This method is called by the framework when it wants to save the task state.
 The default implementation is to encode nothing (stateless).
diff --git a/cu29/prelude/attr.copper_runtime.html b/cu29/prelude/attr.copper_runtime.html
index c67f4804d..9cd5e1997 100644
--- a/cu29/prelude/attr.copper_runtime.html
+++ b/cu29/prelude/attr.copper_runtime.html
@@ -1,4 +1,4 @@
-copper_runtime in cu29::prelude - Rust
    cu29::prelude
    Attribute Macro copper_runtime
    Source 
    #[copper_runtime]
    Expand description
    Adds #[copper_runtime(config = “path”, sim_mode = false/true)] to your application struct to generate the runtime.
-if sim_mode is ommited, it is set to false.
+copper_runtime in cu29::prelude - Rust
    cu29::prelude
    Attribute Macro copper_runtime
    Source 
    #[copper_runtime]
    Expand description
    Adds #[copper_runtime(config = “path”, sim_mode = false/true)] to your application struct to generate the runtime.
+if sim_mode is omitted, it is set to false.
 This will add a “runtime” field to your struct and implement the “new” and “run” methods.
    
 
    
\ No newline at end of file
diff --git a/cu29/prelude/config/struct.Cnx.html b/cu29/prelude/config/struct.Cnx.html
index b0b605b7e..be6759ccd 100644
--- a/cu29/prelude/config/struct.Cnx.html
+++ b/cu29/prelude/config/struct.Cnx.html
@@ -4,7 +4,7 @@
     pub store: Option<bool>,
     /* private fields */
 }
    Expand description
    This represents a connection between 2 tasks (nodes) in the configuration graph.
    
-
    Fields§
    §msg: String
    Message type exchanged betwee src and dst.
    
+
    Fields§
    §msg: String
    Message type exchanged between src and dst.
    
 
    §batch: Option<u32>
    Tells Copper to batch messages before sending the buffer to the next node.
 If None, Copper will just send 1 message at a time.
 If Some(n), Copper will batch n messages before sending the buffer.
    
diff --git a/cu29/prelude/config/struct.CuConfig.html b/cu29/prelude/config/struct.CuConfig.html
index f8d3ae60b..c470e4dc4 100644
--- a/cu29/prelude/config/struct.CuConfig.html
+++ b/cu29/prelude/config/struct.CuConfig.html
@@ -4,7 +4,7 @@
     pub logging: Option<LoggingConfig>,
 }
    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.

    -

    Fields§

    §graph: StableGraph<Node, Cnx>§monitor: Option<MonitorConfig>§logging: Option<LoggingConfig>

    Implementations§

    Source§

    impl CuConfig

    The implementation has a lot of conveinence methods to manipulate +

    Fields§

    §graph: StableGraph<Node, Cnx>§monitor: Option<MonitorConfig>§logging: Option<LoggingConfig>

    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 add_node(&mut self, node: Node) -> u32

    Add a new node to the configuration graph.

    Source

    pub fn get_node(&self, node_id: u32) -> Option<&Node>

    Get the node with the given id.

    diff --git a/cu29/prelude/curuntime/fn.compute_runtime_plan.html b/cu29/prelude/curuntime/fn.compute_runtime_plan.html index f6ece4feb..89593de0c 100644 --- a/cu29/prelude/curuntime/fn.compute_runtime_plan.html +++ b/cu29/prelude/curuntime/fn.compute_runtime_plan.html @@ -1,5 +1,5 @@ -compute_runtime_plan in cu29::prelude::curuntime - Rust
    cu29::prelude::curuntime

    Function compute_runtime_plan

    Source 
    pub fn compute_runtime_plan(
+compute_runtime_plan in cu29::prelude::curuntime - Rust
    cu29::prelude::curuntime
    Function compute_runtime_plan
    Source 
    pub fn compute_runtime_plan(
     config: &CuConfig,
 ) -> Result<CuExecutionLoop, CuError>
    Expand description
    This is the main heuristics to compute an execution plan at compilation time.
-TODO: Make that heuristic plugable.
    
+TODO: Make that heuristic pluggable.
    
 
    
\ No newline at end of file
diff --git a/cu29/prelude/curuntime/index.html b/cu29/prelude/curuntime/index.html
index 931ac536d..394449309 100644
--- a/cu29/prelude/curuntime/index.html
+++ b/cu29/prelude/curuntime/index.html
@@ -6,4 +6,4 @@
 if loop_count is None, the loop is infinite.
  • CuExecutionStep
    This structure represents a step in the execution plan.
  • CuRuntime
    This is the main structure that will be injected as a member of the Application struct. CT is the tuple of all the tasks in order of execution. CL is the type of the copper list, representing the input/output messages for all the tasks.

    • Enums§

    Functions§

    \ No newline at end of file +TODO: Make that heuristic pluggable.

  • find_task_type_for_id
    • \ No newline at end of file diff --git a/cu29/prelude/cutask/index.html b/cu29/prelude/cutask/index.html index 3104e4d10..f2cba502c 100644 --- a/cu29/prelude/cutask/index.html +++ b/cu29/prelude/cutask/index.html @@ -3,5 +3,5 @@

    Structs§

    • CuCompactString
    • CuMsg
      CuMsg is the envelope holding the msg payload and the metadata between tasks.
    • CuMsgMetadata
      CuMsgMetadata is a structure that contains metadata common to all CuMsgs.

    Traits§

    • CuMsgPack
    • CuMsgPayload
    • CuSinkTask
      A Sink Task is a task that only consumes messages. For example drivers for actuators are Sink Tasks.
    • CuSrcTask
      A Src Task is a task that only produces messages. For example drivers for sensors are Src Tasks. They are in push mode from the runtime. To set the frequency of the pulls and align them to any hw, see the runtime configuration. -Note: A source has the priviledge to have a clock passed to it vs a frozen clock.
    • CuTask
      This is the most generic Task of copper. It is a “transform” task deriving an output from an input.
    • Freezable
      The internal state of a task needs to be serializable -so the framework can take a snapshop of the task graph.
    \ No newline at end of file +Note: A source has the privilege to have a clock passed to it vs a frozen clock.
  • CuTask
    This is the most generic Task of copper. It is a “transform” task deriving an output from an input.
  • Freezable
    The internal state of a task needs to be serializable +so the framework can take a snapshot of the task graph.
    • \ No newline at end of file diff --git a/cu29/prelude/cutask/struct.CuMsgMetadata.html b/cu29/prelude/cutask/struct.CuMsgMetadata.html index bdf39cf1c..8915634b3 100644 --- a/cu29/prelude/cutask/struct.CuMsgMetadata.html +++ b/cu29/prelude/cutask/struct.CuMsgMetadata.html @@ -7,7 +7,7 @@ §tov: Tov

    The time of validity of the message. It can be undefined (None), one measure point or a range of measures (TimeRange).

    §status_txt: CuCompactString

    A small string for real time feedback purposes. -This is usefull for to display on the field when the tasks are operating correctly.

    +This is useful for to display on the field when the tasks are operating correctly.

    Implementations§

    Source§

    impl CuMsgMetadata

    Source

    pub fn set_status(&mut self, status: impl ToCompactString)

    Trait Implementations§

    Source§

    impl<'__de> BorrowDecode<'__de> for CuMsgMetadata

    Source§

    fn borrow_decode<__D>(decoder: &mut __D) -> Result<CuMsgMetadata, DecodeError>
    where __D: BorrowDecoder<'__de>,

    Attempt to decode this type with the given BorrowDecode.
    Source§

    impl Clone for CuMsgMetadata

    Source§

    fn clone(&self) -> CuMsgMetadata

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

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

    Performs copy-assignment from source. Read more
    Source§

    impl Debug for CuMsgMetadata

    Source§

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

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

    impl Decode for CuMsgMetadata

    Source§

    fn decode<__D>(decoder: &mut __D) -> Result<CuMsgMetadata, DecodeError>
    where __D: Decoder,

    Attempt to decode this type with the given Decode.
    Source§

    impl Default for CuMsgMetadata

    Source§

    fn default() -> CuMsgMetadata

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

    impl<'de> Deserialize<'de> for CuMsgMetadata

    Source§

    fn deserialize<__D>( diff --git a/cu29/prelude/cutask/trait.CuSrcTask.html b/cu29/prelude/cutask/trait.CuSrcTask.html index 42c68b252..6fe7fa3b1 100644 --- a/cu29/prelude/cutask/trait.CuSrcTask.html +++ b/cu29/prelude/cutask/trait.CuSrcTask.html @@ -1,4 +1,4 @@ -CuSrcTask in cu29::prelude::cutask - Rust
    cu29::prelude::cutask

    Trait CuSrcTask

    Source 
    pub trait CuSrcTask<'cl>: Freezable {
+CuSrcTask in cu29::prelude::cutask - Rust
    cu29::prelude::cutask
    Trait CuSrcTask
    Source 
    pub trait CuSrcTask<'cl>: Freezable {
     type Output: CuMsgPack<'cl>;
 
     // Required methods
@@ -18,7 +18,7 @@
 }
    Expand description
    A Src Task is a task that only produces messages. For example drivers for sensors are Src Tasks.
 They are in push mode from the runtime.
 To set the frequency of the pulls and align them to any hw, see the runtime configuration.
-Note: A source has the priviledge to have a clock passed to it vs a frozen clock.
    
+Note: A source has the privilege to have a clock passed to it vs a frozen clock.
    
 
    Required Associated Types§
    Source
    type Output: CuMsgPack<'cl>
    Required Methods§
    Source
    fn new(_config: Option<&ComponentConfig>) -> Result<Self, CuError>
    where
     Self: Sized,
    Here you need to initialize everything your task will need for the duration of its lifetime.
 The config allows you to access the configuration of the task.
    
diff --git a/cu29/prelude/cutask/trait.Freezable.html b/cu29/prelude/cutask/trait.Freezable.html
index dd1d43cfc..6d08a9b8d 100644
--- a/cu29/prelude/cutask/trait.Freezable.html
+++ b/cu29/prelude/cutask/trait.Freezable.html
@@ -1,11 +1,11 @@
-Freezable in cu29::prelude::cutask - Rust
    cu29::prelude::cutask
    Trait Freezable
    Source 
    pub trait Freezable {
+Freezable in cu29::prelude::cutask - Rust
    cu29::prelude::cutask
    Trait Freezable
    Source 
    pub trait Freezable {
     // Provided methods
     fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>
        where E: Encoder { ... }
     fn thaw<D>(&mut self, decoder: &mut D) -> Result<(), DecodeError>
        where D: Decoder { ... }
 }
    Expand description
    The internal state of a task needs to be serializable
-so the framework can take a snapshop of the task graph.
    
+so the framework can take a snapshot of the task graph.
    
 
    Provided Methods§
    Source
    fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>
    where
     E: Encoder,
    This method is called by the framework when it wants to save the task state.
 The default implementation is to encode nothing (stateless).
diff --git a/cu29/prelude/fn.compute_runtime_plan.html b/cu29/prelude/fn.compute_runtime_plan.html
index a7f72c44d..6291a0caf 100644
--- a/cu29/prelude/fn.compute_runtime_plan.html
+++ b/cu29/prelude/fn.compute_runtime_plan.html
@@ -1,5 +1,5 @@
-compute_runtime_plan in cu29::prelude - Rust
    cu29::prelude
    Function compute_runtime_plan
    Source 
    pub fn compute_runtime_plan(
+compute_runtime_plan in cu29::prelude - Rust
    cu29::prelude
    Function compute_runtime_plan
    Source 
    pub fn compute_runtime_plan(
     config: &CuConfig,
 ) -> Result<CuExecutionLoop, CuError>
    Expand description
    This is the main heuristics to compute an execution plan at compilation time.
-TODO: Make that heuristic plugable.
    
+TODO: Make that heuristic pluggable.
    
 
    
\ No newline at end of file
diff --git a/cu29/prelude/index.html b/cu29/prelude/index.html
index df9113bb8..881ce8360 100644
--- a/cu29/prelude/index.html
+++ b/cu29/prelude/index.html
@@ -34,17 +34,17 @@
 It is clone resilient, ie a clone will be the same clock, even when mocked.
  • RobotClockMock
    A mock clock that can be controlled by the user.
  • ScopedAllocCounter
    A simple struct that counts the number of bytes allocated and deallocated in a scope.
  • SectionHandle
    A SectionHandle is a handle to a section in the datalogger.
 It allows to track the lifecycle of a section of the datalogger.
  • SectionHeader
    Each concurrent sublogger is tracked through a section header.
 They form a linked list of sections.
-The entry type is used to identify the type of data in the section.
  • SimpleFileWriter
    This allows this crate to be used outside of Copper (ie. decoupling it from the unifiedlog.
  • UnifiedLoggerBuilder
    Use this builder to create a new DataLogger.
  • UnifiedLoggerIOReader
    This a convience wrapper around the UnifiedLoggerRead to implement the Read trait.
  • UnifiedLoggerRead
    A read side of the datalogger.
  • UnifiedLoggerWrite
    A write side of the datalogger.
    • Enums§
    Enums§
    • AllocatedSection
    • CopperListState
      Those are the possible states along the lifetime of a CopperList.
    • CuExecutionUnit
      This structure represents a step in the execution plan.
    • CuTaskCallbackState
      This is the state that will be passed to the simulation support to hook
 into the lifecycle of the tasks.
    • CuTaskState
      The state of a task.
    • CuTaskType
      Copper tasks can be of 3 types:
    • Decision
      Monitor decision to be taken when a task errored out.
    • SimOverride
      This is the answer the simulator can give to control the simulation flow.
    • Tov
      The time of validity of a message can be more than one time but can be a time range of Tovs.
 For example a sub scan for a lidar, a set of images etc… can have a range of validity.
    • UnifiedLogType
      Defines the types of what can be logged in the unified logger.
    • UnifiedLogger
      Holder of the read or write side of the datalogger.
    • Value
    Constants§
    Statics§
    Traits§
    • ClockProvider
      A trait to provide a clock to the runtime.
    • CopperListTuple
      A CopperListTuple needs to be encodable, decodable and fixed size in memory.
    • CuMonitor
      Trait to implement a monitoring task.
    • CuMsgPack
    • CuMsgPayload
    • CuSinkTask
      A Sink Task is a task that only consumes messages. For example drivers for actuators are Sink Tasks.
    • CuSrcTask
      A Src Task is a task that only produces messages. For example drivers for sensors are Src Tasks.
 They are in push mode from the runtime.
 To set the frequency of the pulls and align them to any hw, see the runtime configuration.
-Note: A source has the priviledge to have a clock passed to it vs a frozen clock.
    • CuTask
      This is the most generic Task of copper. It is a “transform” task deriving an output from an input.
    • Freezable
      The internal state of a task needs to be serializable
-so the framework can take a snapshop of the task graph.
    • WriteStream
      Defines a basic write, append only stream trait to be able to log or send serializable objects.
    Functions§
    • compute_runtime_plan
      This is the main heuristics to compute an execution plan at compilation time.
-TODO: Make that heuristic plugable.
    • default_log_index_dir
      Convenience function to returns the default path for the log index directory.
    • find_task_type_for_id
    • format_logline
      Text log line formatter.
    • log
      Function called from generated code to log data.
+Note: A source has the privilege to have a clock passed to it vs a frozen clock.
    • CuTask
      This is the most generic Task of copper. It is a “transform” task deriving an output from an input.
    • Freezable
      The internal state of a task needs to be serializable
+so the framework can take a snapshot of the task graph.
    • WriteStream
      Defines a basic write, append only stream trait to be able to log or send serializable objects.
    Functions§
    Type Aliases§
    Attribute Macros§
    • copper_runtime
      Adds #[copper_runtime(config = “path”, sim_mode = false/true)] to your application struct to generate the runtime.
-if sim_mode is ommited, it is set to false.
+if sim_mode is omitted, it is set to false.
 This will add a “runtime” field to your struct and implement the “new” and “run” methods.
    
\ No newline at end of file
diff --git a/cu29/prelude/macro.debug.html b/cu29/prelude/macro.debug.html
index a96810a1f..fbdce1346 100644
--- a/cu29/prelude/macro.debug.html
+++ b/cu29/prelude/macro.debug.html
@@ -10,7 +10,7 @@ 
    §Example
    
 let a = 1;
 let b = 2;
 debug!("a = {}, b = {}", my_value = a, b); // named and unnamed parameters
    
-
    You can retreive this data using the log_reader generated with your project and giving it the
+
    You can retrieve this data using the log_reader generated with your project and giving it the
 unified .copper log file and the string index file generated at compile time.
    
 
    Note: In debug mode, the log will also be printed to the console. (ie slooow).
 In release mode, the log will be only be written to the unified logger.
    
diff --git a/cu29/prelude/struct.Cnx.html b/cu29/prelude/struct.Cnx.html
index ea2bb5190..ea6ce2cda 100644
--- a/cu29/prelude/struct.Cnx.html
+++ b/cu29/prelude/struct.Cnx.html
@@ -4,7 +4,7 @@
     pub store: Option<bool>,
     /* private fields */
 }
    Expand description

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

    -

    Fields§

    §msg: String

    Message type exchanged betwee src and dst.

    +

    Fields§

    §msg: String

    Message type exchanged between src and dst.

    §batch: Option<u32>

    Tells Copper to batch messages before sending the buffer to the next node. If None, Copper will just send 1 message at a time. If Some(n), Copper will batch n messages before sending the buffer.

    diff --git a/cu29/prelude/struct.CuConfig.html b/cu29/prelude/struct.CuConfig.html index 7d514f492..04e73ebde 100644 --- a/cu29/prelude/struct.CuConfig.html +++ b/cu29/prelude/struct.CuConfig.html @@ -4,7 +4,7 @@ pub logging: Option<LoggingConfig>, }
    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.

    -

    Fields§

    §graph: StableGraph<Node, Cnx>§monitor: Option<MonitorConfig>§logging: Option<LoggingConfig>

    Implementations§

    Source§

    impl CuConfig

    The implementation has a lot of conveinence methods to manipulate +

    Fields§

    §graph: StableGraph<Node, Cnx>§monitor: Option<MonitorConfig>§logging: Option<LoggingConfig>

    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 add_node(&mut self, node: Node) -> u32

    Add a new node to the configuration graph.

    Source

    pub fn get_node(&self, node_id: u32) -> Option<&Node>

    Get the node with the given id.

    diff --git a/cu29/prelude/struct.CuMsgMetadata.html b/cu29/prelude/struct.CuMsgMetadata.html index 8a54f96fc..d864e226d 100644 --- a/cu29/prelude/struct.CuMsgMetadata.html +++ b/cu29/prelude/struct.CuMsgMetadata.html @@ -7,7 +7,7 @@
    §tov: Tov

    The time of validity of the message. It can be undefined (None), one measure point or a range of measures (TimeRange).

    §status_txt: CuCompactString

    A small string for real time feedback purposes. -This is usefull for to display on the field when the tasks are operating correctly.

    +This is useful for to display on the field when the tasks are operating correctly.

    Implementations§

    Source§

    impl CuMsgMetadata

    Source

    pub fn set_status(&mut self, status: impl ToCompactString)

    Trait Implementations§

    Source§

    impl<'__de> BorrowDecode<'__de> for CuMsgMetadata

    Source§

    fn borrow_decode<__D>(decoder: &mut __D) -> Result<CuMsgMetadata, DecodeError>
    where __D: BorrowDecoder<'__de>,

    Attempt to decode this type with the given BorrowDecode.
    Source§

    impl Clone for CuMsgMetadata

    Source§

    fn clone(&self) -> CuMsgMetadata

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

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

    Performs copy-assignment from source. Read more
    Source§

    impl Debug for CuMsgMetadata

    Source§

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

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

    impl Decode for CuMsgMetadata

    Source§

    fn decode<__D>(decoder: &mut __D) -> Result<CuMsgMetadata, DecodeError>
    where __D: Decoder,

    Attempt to decode this type with the given Decode.
    Source§

    impl Default for CuMsgMetadata

    Source§

    fn default() -> CuMsgMetadata

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

    impl<'de> Deserialize<'de> for CuMsgMetadata

    Source§

    fn deserialize<__D>( diff --git a/cu29/prelude/struct.UnifiedLoggerIOReader.html b/cu29/prelude/struct.UnifiedLoggerIOReader.html index 2b62a2575..2d4898978 100644 --- a/cu29/prelude/struct.UnifiedLoggerIOReader.html +++ b/cu29/prelude/struct.UnifiedLoggerIOReader.html @@ -1,4 +1,4 @@ -UnifiedLoggerIOReader in cu29::prelude - Rust
    cu29::prelude

    Struct UnifiedLoggerIOReader

    pub struct UnifiedLoggerIOReader { /* private fields */ }
    Expand description

    This a convience wrapper around the UnifiedLoggerRead to implement the Read trait.

    +UnifiedLoggerIOReader in cu29::prelude - Rust
    cu29::prelude

    Struct UnifiedLoggerIOReader

    pub struct UnifiedLoggerIOReader { /* private fields */ }
    Expand description

    This a convenience wrapper around the UnifiedLoggerRead to implement the Read trait.

    Implementations§

    §

    impl UnifiedLoggerIOReader

    pub fn new( logger: UnifiedLoggerRead, log_type: UnifiedLogType, diff --git a/cu29/prelude/trait.CuSrcTask.html b/cu29/prelude/trait.CuSrcTask.html index b1fb29717..2920ef0a8 100644 --- a/cu29/prelude/trait.CuSrcTask.html +++ b/cu29/prelude/trait.CuSrcTask.html @@ -1,4 +1,4 @@ -CuSrcTask in cu29::prelude - Rust
    cu29::prelude

    Trait CuSrcTask

    Source 
    pub trait CuSrcTask<'cl>: Freezable {
+CuSrcTask in cu29::prelude - Rust
    cu29::prelude
    Trait CuSrcTask
    Source 
    pub trait CuSrcTask<'cl>: Freezable {
     type Output: CuMsgPack<'cl>;
 
     // Required methods
@@ -18,7 +18,7 @@
 }
    Expand description
    A Src Task is a task that only produces messages. For example drivers for sensors are Src Tasks.
 They are in push mode from the runtime.
 To set the frequency of the pulls and align them to any hw, see the runtime configuration.
-Note: A source has the priviledge to have a clock passed to it vs a frozen clock.
    
+Note: A source has the privilege to have a clock passed to it vs a frozen clock.
    
 
    Required Associated Types§
    Source
    type Output: CuMsgPack<'cl>
    Required Methods§
    Source
    fn new(_config: Option<&ComponentConfig>) -> Result<Self, CuError>
    where
     Self: Sized,
    Here you need to initialize everything your task will need for the duration of its lifetime.
 The config allows you to access the configuration of the task.
    
diff --git a/cu29/prelude/trait.Freezable.html b/cu29/prelude/trait.Freezable.html
index 040f8aaaf..9a0a334d5 100644
--- a/cu29/prelude/trait.Freezable.html
+++ b/cu29/prelude/trait.Freezable.html
@@ -1,11 +1,11 @@
-Freezable in cu29::prelude - Rust
    cu29::prelude
    Trait Freezable
    Source 
    pub trait Freezable {
+Freezable in cu29::prelude - Rust
    cu29::prelude
    Trait Freezable
    Source 
    pub trait Freezable {
     // Provided methods
     fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>
        where E: Encoder { ... }
     fn thaw<D>(&mut self, decoder: &mut D) -> Result<(), DecodeError>
        where D: Decoder { ... }
 }
    Expand description
    The internal state of a task needs to be serializable
-so the framework can take a snapshop of the task graph.
    
+so the framework can take a snapshot of the task graph.
    
 
    Provided Methods§
    Source
    fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>
    where
     E: Encoder,
    This method is called by the framework when it wants to save the task state.
 The default implementation is to encode nothing (stateless).
diff --git a/cu29_derive/attr.copper_runtime.html b/cu29_derive/attr.copper_runtime.html
index e9df75c32..2a83351bf 100644
--- a/cu29_derive/attr.copper_runtime.html
+++ b/cu29_derive/attr.copper_runtime.html
@@ -1,4 +1,4 @@
-copper_runtime in cu29_derive - Rust
    cu29_derive
    Attribute Macro copper_runtime
    Source 
    #[copper_runtime]
    Expand description
    Adds #[copper_runtime(config = “path”, sim_mode = false/true)] to your application struct to generate the runtime.
-if sim_mode is ommited, it is set to false.
+copper_runtime in cu29_derive - Rust
    cu29_derive
    Attribute Macro copper_runtime
    Source 
    #[copper_runtime]
    Expand description
    Adds #[copper_runtime(config = “path”, sim_mode = false/true)] to your application struct to generate the runtime.
+if sim_mode is omitted, it is set to false.
 This will add a “runtime” field to your struct and implement the “new” and “run” methods.
    
 
    
\ No newline at end of file
diff --git a/cu29_derive/index.html b/cu29_derive/index.html
index 4561c16ff..3bd921132 100644
--- a/cu29_derive/index.html
+++ b/cu29_derive/index.html
@@ -1,5 +1,5 @@
 cu29_derive - Rust
    Crate cu29_derive
    Source 
    Macros§
    • gen_cumsgs
      Generates the CopperList content type from a config.
 gen_cumsgs!(“path/to/config.toml”)
 It will create a new type called CuMsgs you can pass to the log reader for decoding:
    Attribute Macros§
    • copper_runtime
      Adds #[copper_runtime(config = “path”, sim_mode = false/true)] to your application struct to generate the runtime.
-if sim_mode is ommited, it is set to false.
+if sim_mode is omitted, it is set to false.
 This will add a “runtime” field to your struct and implement the “new” and “run” methods.
    
\ No newline at end of file
diff --git a/cu29_log_derive/macro.debug.html b/cu29_log_derive/macro.debug.html
index ebeabab4b..e3811cc6a 100644
--- a/cu29_log_derive/macro.debug.html
+++ b/cu29_log_derive/macro.debug.html
@@ -10,7 +10,7 @@ 
    §Example
    
 let a = 1;
 let b = 2;
 debug!("a = {}, b = {}", my_value = a, b); // named and unnamed parameters
    
-
    You can retreive this data using the log_reader generated with your project and giving it the
+
    You can retrieve this data using the log_reader generated with your project and giving it the
 unified .copper log file and the string index file generated at compile time.
    
 
    Note: In debug mode, the log will also be printed to the console. (ie slooow).
 In release mode, the log will be only be written to the unified logger.
    
diff --git a/cu29_rendercfg/config/struct.Cnx.html b/cu29_rendercfg/config/struct.Cnx.html
index 990a97679..1450fd0d5 100644
--- a/cu29_rendercfg/config/struct.Cnx.html
+++ b/cu29_rendercfg/config/struct.Cnx.html
@@ -6,7 +6,7 @@
     pub store: Option<bool>,
 }
    Expand description

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

    Fields§

    §src: String

    Source node id.

    -
    §dst: String§msg: String

    Message type exchanged betwee src and dst.

    +
    §dst: String§msg: String

    Message type exchanged between src and dst.

    §batch: Option<u32>

    Tells Copper to batch messages before sending the buffer to the next node. If None, Copper will just send 1 message at a time. If Some(n), Copper will batch n messages before sending the buffer.

    diff --git a/cu29_rendercfg/config/struct.CuConfig.html b/cu29_rendercfg/config/struct.CuConfig.html index cf20b8ed7..62332f252 100644 --- a/cu29_rendercfg/config/struct.CuConfig.html +++ b/cu29_rendercfg/config/struct.CuConfig.html @@ -4,7 +4,7 @@ pub logging: Option<LoggingConfig>, }
    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.

    -

    Fields§

    §graph: StableDiGraph<Node, Cnx, u32>§monitor: Option<MonitorConfig>§logging: Option<LoggingConfig>

    Implementations§

    Source§

    impl CuConfig

    The implementation has a lot of conveinence methods to manipulate +

    Fields§

    §graph: StableDiGraph<Node, Cnx, u32>§monitor: Option<MonitorConfig>§logging: Option<LoggingConfig>

    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 add_node(&mut self, node: Node) -> u32

    Add a new node to the configuration graph.

    Source

    pub fn get_node(&self, node_id: u32) -> Option<&Node>

    Get the node with the given id.

    diff --git a/cu29_runtime/config/struct.Cnx.html b/cu29_runtime/config/struct.Cnx.html index 07de0e7f9..6666b0518 100644 --- a/cu29_runtime/config/struct.Cnx.html +++ b/cu29_runtime/config/struct.Cnx.html @@ -4,7 +4,7 @@ pub store: Option<bool>, /* private fields */ }
    Expand description

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

    -

    Fields§

    §msg: String

    Message type exchanged betwee src and dst.

    +

    Fields§

    §msg: String

    Message type exchanged between src and dst.

    §batch: Option<u32>

    Tells Copper to batch messages before sending the buffer to the next node. If None, Copper will just send 1 message at a time. If Some(n), Copper will batch n messages before sending the buffer.

    diff --git a/cu29_runtime/config/struct.CuConfig.html b/cu29_runtime/config/struct.CuConfig.html index 219d5140e..3d6d94058 100644 --- a/cu29_runtime/config/struct.CuConfig.html +++ b/cu29_runtime/config/struct.CuConfig.html @@ -4,7 +4,7 @@ pub logging: Option<LoggingConfig>, }
    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.

    -

    Fields§

    §graph: StableDiGraph<Node, Cnx, NodeId>§monitor: Option<MonitorConfig>§logging: Option<LoggingConfig>

    Implementations§

    Source§

    impl CuConfig

    The implementation has a lot of conveinence methods to manipulate +

    Fields§

    §graph: StableDiGraph<Node, Cnx, NodeId>§monitor: Option<MonitorConfig>§logging: Option<LoggingConfig>

    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 add_node(&mut self, node: Node) -> NodeId

    Add a new node to the configuration graph.

    Source

    pub fn get_node(&self, node_id: NodeId) -> Option<&Node>

    Get the node with the given id.

    diff --git a/cu29_runtime/curuntime/fn.compute_runtime_plan.html b/cu29_runtime/curuntime/fn.compute_runtime_plan.html index e293ea577..a8ce4833c 100644 --- a/cu29_runtime/curuntime/fn.compute_runtime_plan.html +++ b/cu29_runtime/curuntime/fn.compute_runtime_plan.html @@ -1,3 +1,3 @@ -compute_runtime_plan in cu29_runtime::curuntime - Rust
    cu29_runtime::curuntime

    Function compute_runtime_plan

    Source 
    pub fn compute_runtime_plan(config: &CuConfig) -> CuResult<CuExecutionLoop>
    Expand description

    This is the main heuristics to compute an execution plan at compilation time. -TODO: Make that heuristic plugable.

    +compute_runtime_plan in cu29_runtime::curuntime - Rust
    cu29_runtime::curuntime

    Function compute_runtime_plan

    Source 
    pub fn compute_runtime_plan(config: &CuConfig) -> CuResult<CuExecutionLoop>
    Expand description

    This is the main heuristics to compute an execution plan at compilation time. +TODO: Make that heuristic pluggable.

    \ No newline at end of file diff --git a/cu29_runtime/curuntime/index.html b/cu29_runtime/curuntime/index.html index 68953d2e5..946e8ad0d 100644 --- a/cu29_runtime/curuntime/index.html +++ b/cu29_runtime/curuntime/index.html @@ -6,4 +6,4 @@ if loop_count is None, the loop is infinite.
  • CuExecutionStep
    This structure represents a step in the execution plan.
  • CuRuntime
    This is the main structure that will be injected as a member of the Application struct. CT is the tuple of all the tasks in order of execution. CL is the type of the copper list, representing the input/output messages for all the tasks.

    • Enums§

    Functions§

    \ No newline at end of file +TODO: Make that heuristic pluggable.
  • find_task_type_for_id
    • \ No newline at end of file diff --git a/cu29_runtime/cutask/index.html b/cu29_runtime/cutask/index.html index a2624872d..ffd1d7283 100644 --- a/cu29_runtime/cutask/index.html +++ b/cu29_runtime/cutask/index.html @@ -3,5 +3,5 @@

    Structs§

    • CuCompactString
    • CuMsg
      CuMsg is the envelope holding the msg payload and the metadata between tasks.
    • CuMsgMetadata
      CuMsgMetadata is a structure that contains metadata common to all CuMsgs.

    Traits§

    • CuMsgPack
    • CuMsgPayload
    • CuSinkTask
      A Sink Task is a task that only consumes messages. For example drivers for actuators are Sink Tasks.
    • CuSrcTask
      A Src Task is a task that only produces messages. For example drivers for sensors are Src Tasks. They are in push mode from the runtime. To set the frequency of the pulls and align them to any hw, see the runtime configuration. -Note: A source has the priviledge to have a clock passed to it vs a frozen clock.
    • CuTask
      This is the most generic Task of copper. It is a “transform” task deriving an output from an input.
    • Freezable
      The internal state of a task needs to be serializable -so the framework can take a snapshop of the task graph.
    \ No newline at end of file +Note: A source has the privilege to have a clock passed to it vs a frozen clock.
  • CuTask
    This is the most generic Task of copper. It is a “transform” task deriving an output from an input.
  • Freezable
    The internal state of a task needs to be serializable +so the framework can take a snapshot of the task graph.
    • \ No newline at end of file diff --git a/cu29_runtime/cutask/struct.CuMsgMetadata.html b/cu29_runtime/cutask/struct.CuMsgMetadata.html index c28c1845f..5069e8a0a 100644 --- a/cu29_runtime/cutask/struct.CuMsgMetadata.html +++ b/cu29_runtime/cutask/struct.CuMsgMetadata.html @@ -7,7 +7,7 @@

    §tov: Tov

    The time of validity of the message. It can be undefined (None), one measure point or a range of measures (TimeRange).

    §status_txt: CuCompactString

    A small string for real time feedback purposes. -This is usefull for to display on the field when the tasks are operating correctly.

    +This is useful for to display on the field when the tasks are operating correctly.

    Implementations§

    Source§

    impl CuMsgMetadata

    Source

    pub fn set_status(&mut self, status: impl ToCompactString)

    Trait Implementations§

    Source§

    impl<'__de> BorrowDecode<'__de> for CuMsgMetadata

    Source§

    fn borrow_decode<__D: BorrowDecoder<'__de>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

    Attempt to decode this type with the given BorrowDecode.
    Source§

    impl Clone for CuMsgMetadata

    Source§

    fn clone(&self) -> CuMsgMetadata

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

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

    Performs copy-assignment from source. Read more
    Source§

    impl Debug for CuMsgMetadata

    Source§

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

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

    impl Decode for CuMsgMetadata

    Source§

    fn decode<__D: Decoder>(decoder: &mut __D) -> Result<Self, DecodeError>

    Attempt to decode this type with the given Decode.
    Source§

    impl Default for CuMsgMetadata

    Source§

    fn default() -> Self

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

    impl<'de> Deserialize<'de> for CuMsgMetadata

    Source§

    fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
    where diff --git a/cu29_runtime/cutask/trait.CuSrcTask.html b/cu29_runtime/cutask/trait.CuSrcTask.html index 47137f164..695447b44 100644 --- a/cu29_runtime/cutask/trait.CuSrcTask.html +++ b/cu29_runtime/cutask/trait.CuSrcTask.html @@ -1,4 +1,4 @@ -CuSrcTask in cu29_runtime::cutask - Rust
    cu29_runtime::cutask

    Trait CuSrcTask

    Source 
    pub trait CuSrcTask<'cl>: Freezable {
+CuSrcTask in cu29_runtime::cutask - Rust
    cu29_runtime::cutask
    Trait CuSrcTask
    Source 
    pub trait CuSrcTask<'cl>: Freezable {
     type Output: CuMsgPack<'cl>;
 
     // Required methods
@@ -18,7 +18,7 @@
 }
    Expand description
    A Src Task is a task that only produces messages. For example drivers for sensors are Src Tasks.
 They are in push mode from the runtime.
 To set the frequency of the pulls and align them to any hw, see the runtime configuration.
-Note: A source has the priviledge to have a clock passed to it vs a frozen clock.
    
+Note: A source has the privilege to have a clock passed to it vs a frozen clock.
    
 
    Required Associated Types§
    Source
    type Output: CuMsgPack<'cl>
    Required Methods§
    Source
    fn new(_config: Option<&ComponentConfig>) -> CuResult<Self>
    where
     Self: Sized,
    Here you need to initialize everything your task will need for the duration of its lifetime.
 The config allows you to access the configuration of the task.
    
diff --git a/cu29_runtime/cutask/trait.Freezable.html b/cu29_runtime/cutask/trait.Freezable.html
index 6bcf9ce12..faa0a401d 100644
--- a/cu29_runtime/cutask/trait.Freezable.html
+++ b/cu29_runtime/cutask/trait.Freezable.html
@@ -1,9 +1,9 @@
-Freezable in cu29_runtime::cutask - Rust
    cu29_runtime::cutask
    Trait Freezable
    Source 
    pub trait Freezable {
+Freezable in cu29_runtime::cutask - Rust
    cu29_runtime::cutask
    Trait Freezable
    Source 
    pub trait Freezable {
     // Provided methods
     fn freeze<E: Encoder>(&self, encoder: &mut E) -> Result<(), EncodeError> { ... }
     fn thaw<D: Decoder>(&mut self, decoder: &mut D) -> Result<(), DecodeError> { ... }
 }
    Expand description
    The internal state of a task needs to be serializable
-so the framework can take a snapshop of the task graph.
    
+so the framework can take a snapshot of the task graph.
    
 
    Provided Methods§
    Source
    fn freeze<E: Encoder>(&self, encoder: &mut E) -> Result<(), EncodeError>
    This method is called by the framework when it wants to save the task state.
 The default implementation is to encode nothing (stateless).
 If you have a state, you need to implement this method.
    
diff --git a/cu29_unifiedlog/index.html b/cu29_unifiedlog/index.html
index fcd45901f..ce895f873 100644
--- a/cu29_unifiedlog/index.html
+++ b/cu29_unifiedlog/index.html
@@ -1,4 +1,4 @@
 cu29_unifiedlog - Rust
    Crate cu29_unifiedlog
    Source 
    Structs§
    • SectionHandle
      A SectionHandle is a handle to a section in the datalogger.
 It allows to track the lifecycle of a section of the datalogger.
    • SectionHeader
      Each concurrent sublogger is tracked through a section header.
 They form a linked list of sections.
-The entry type is used to identify the type of data in the section.
    • UnifiedLoggerBuilder
      Use this builder to create a new DataLogger.
    • UnifiedLoggerIOReader
      This a convience wrapper around the UnifiedLoggerRead to implement the Read trait.
    • UnifiedLoggerRead
      A read side of the datalogger.
    • UnifiedLoggerWrite
      A write side of the datalogger.
    Enums§
    Functions§
    • stream_write
      Create a new stream to write to the unifiedlogger.
    
\ No newline at end of file
+The entry type is used to identify the type of data in the section.
  • UnifiedLoggerBuilder
    Use this builder to create a new DataLogger.
  • UnifiedLoggerIOReader
    This a convenience wrapper around the UnifiedLoggerRead to implement the Read trait.
  • UnifiedLoggerRead
    A read side of the datalogger.
  • UnifiedLoggerWrite
    A write side of the datalogger.
    • Enums§
    Functions§
    • stream_write
      Create a new stream to write to the unifiedlogger.
    
\ No newline at end of file
diff --git a/cu29_unifiedlog/struct.UnifiedLoggerIOReader.html b/cu29_unifiedlog/struct.UnifiedLoggerIOReader.html
index a44d70b0c..99f995dce 100644
--- a/cu29_unifiedlog/struct.UnifiedLoggerIOReader.html
+++ b/cu29_unifiedlog/struct.UnifiedLoggerIOReader.html
@@ -1,4 +1,4 @@
-UnifiedLoggerIOReader in cu29_unifiedlog - Rust
    cu29_unifiedlog
    Struct UnifiedLoggerIOReader
    Source 
    pub struct UnifiedLoggerIOReader { /* private fields */ }
    Expand description
    This a convience wrapper around the UnifiedLoggerRead to implement the Read trait.
    
+UnifiedLoggerIOReader in cu29_unifiedlog - Rust
    cu29_unifiedlog
    Struct UnifiedLoggerIOReader
    Source 
    pub struct UnifiedLoggerIOReader { /* private fields */ }
    Expand description
    This a convenience wrapper around the UnifiedLoggerRead to implement the Read trait.
    
 
    Implementations§
    Source§
    impl UnifiedLoggerIOReader
    Source
    pub fn new(logger: UnifiedLoggerRead, log_type: UnifiedLogType) -> Self
    Trait Implementations§
    Source§
    impl Read for UnifiedLoggerIOReader
    Source§
    fn read(&mut self, buf: &mut [u8]) -> Result<usize>
    Pull some bytes from this source into the specified buffer, returning
 how many bytes were read. Read more
    1.36.0 · Source§
    fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
    Like read, except that it reads into a slice of buffers. Read more
    Source§
    fn is_read_vectored(&self) -> bool
    🔬This is a nightly-only experimental API. (can_vector)
    Determines if this Reader has an efficient read_vectored
 implementation. Read more
    1.0.0 · Source§
    fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
    Reads all bytes until EOF in this source, placing them into buf. Read more
    1.0.0 · Source§
    fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
    Reads all bytes until EOF in this source, appending them to buf. Read more
    1.6.0 · Source§
    fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
    Reads the exact number of bytes required to fill buf. Read more
    Source§
    fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
    🔬This is a nightly-only experimental API. (read_buf)
    Pull some bytes from this source into the specified buffer. Read more
    Source§
    fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
    🔬This is a nightly-only experimental API. (read_buf)
    Reads the exact number of bytes required to fill cursor. Read more
    1.0.0 · Source§
    fn by_ref(&mut self) -> &mut Self
    where
diff --git a/help.html b/help.html
index 7de730a1b..baeab6f8b 100644
--- a/help.html
+++ b/help.html
@@ -1 +1 @@
-Help
    Rustdoc help
    Back
    
\ No newline at end of file
+Help
    Rustdoc help
    Back
    
\ No newline at end of file
diff --git a/search.desc/cu29/cu29-desc-0-.js b/search.desc/cu29/cu29-desc-0-.js
index 235ddd71d..604a01637 100644
--- a/search.desc/cu29/cu29-desc-0-.js
+++ b/search.desc/cu29/cu29-desc-0-.js
@@ -1 +1 @@
-searchState.loadedDescShard("cu29", 0, "A CopperListTuple needs to be encodable, decodable and …\nCommon copper Error type.\nContains the error value\nContains the success value\nDefines the types of what can be logged in the unified …\nDefines a basic write, append only stream trait to be able …\nThis module defines the configuration of the copper …\nCopperList is the main data structure used by Copper to …\nCuRuntime is the heart of what copper is running on the …\nThis module contains all the main definition of the traits …\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nSome basic internal monitoring tooling Copper uses to …\nRead a copper configuration from a file.\ncu29::simulation Module\nThis represents a connection between 2 tasks (nodes) in …\nThis is the configuration of a component (like a task …\nCuConfig is the programmatic representation of the …\nA node in the configuration graph. A node represents a …\nNodeId is the unique identifier of a node in the …\nWrapper around the ron::Value to allow for custom …\nTells Copper to batch messages before sending the buffer …\nReturns the argument unchanged.\nCalls U::from(self).\nMessage type exchanged betwee src and dst.\nRead a copper configuration from a file.\nRead a copper configuration from a file.\nTells Copper if it needs to log the messages.\nNot implemented yet. This mask will be used to for example …\nThose are the possible states along the lifetime of a …\nThis structure maintains the entire memory needed by …\nJust a simple struct to hold the various bits needed to …\nThis structure represents a loop in the execution plan. It …\nThis structure represents a step in the execution plan.\nThis structure represents a step in the execution plan.\nThis is the main structure that will be injected as a …\nCopper tasks can be of 3 types:\nThe base clock the runtime will be using to record time.\nThis is the main heuristics to compute an execution plan …\nCopper lists hold in order all the input/output messages …\nthe indices in the copper list of the input messages and …\nNode: node instance\nNodeId: node id of the task to execute\nthe index in the copper list of the output message and its …\nCuTaskType: type of the task\nThe tuple of all the tasks in order of execution.\nCuMsg is the envelope holding the msg payload and the …\nCuMsgMetadata is a structure that contains metadata common …\nA Sink Task is a task that only consumes messages. For …\nA Src Task is a task that only produces messages. For …\nThis is the most generic Task of copper. It is a “…\nThe internal state of a task needs to be serializable so …\nThis metadata is the data that is common to all messages.\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nThe time range used for the processing of this message\nA small string for real time feedback purposes. This is …\nThe time of validity of the message. It can be undefined …\nA simple allocator that counts the number of bytes …\nA Specialized statistics object for CuDuration. It will …\nTrait to implement a monitoring task.\nThe state of a task.\nMonitor decision to be taken when a task errored out.\nAccumulative stat object that can give your some real time …\nA do nothing monitor if no monitor is provided. This is …\nA simple struct that counts the number of bytes allocated …\nCallback that will be trigger at the end of every …\nCallbacked when a Task errored out. The runtime requires …\nCopper friendly wrapper for a fixed size array.\nA trait to provide a clock to the runtime.\nThis represents a connection between 2 tasks (nodes) in …\nThis is the configuration of a component (like a task …\nJust a simple struct to hold the various bits needed to …\nNot implemented yet. This mask will be used to for example …\nThose are the possible states along the lifetime of a …\nA CopperListTuple needs to be encodable, decodable and …\nA simple allocator that counts the number of bytes …\nCopper friendly wrapper for a fixed size array.\nCuConfig is the programmatic representation of the …\nFor Robot times, the underlying type is a u64 representing …\nA Specialized statistics object for CuDuration. It will …\nCommon copper Error type.\nThis structure represents a loop in the execution plan. It …\nThis structure represents a step in the execution plan.\nThis structure represents a step in the execution plan.\nThis structure maintains the entire memory needed by …\nThis is the basic structure for a log entry in Copper.\nTrait to implement a monitoring task.\nCuMsg is the envelope holding the msg payload and the …\nCuMsgMetadata is a structure that contains metadata common …\nThis is the main structure that will be injected as a …\nThis is a placeholder task for a sink task for the …\nThis is a placeholder task for a source task for the …\nA Sink Task is a task that only consumes messages. For …\nA Src Task is a task that only produces messages. For …\nThis is the most generic Task of copper. It is a “…\nThis is the state that will be passed to the simulation …\nThe state of a task.\nCopper tasks can be of 3 types:\nA robot time is just a duration from a fixed point in time.\nRepresents a time range.\nMonitor decision to be taken when a task errored out.\nContains the error value\nEmulated the behavior of an erroring task (same as return …\nThe actual implementation needs to be executed.\nThe callback took care of the logic on the simulation side …\nThe internal state of a task needs to be serializable so …\nA point-in-time wall-clock measurement.\nAccumulative stat object that can give your some real time …\nThe lifetime of this struct is the lifetime of the logger.\nCallbacked when a task is created. It gives you the …\nA do nothing monitor if no monitor is provided. This is …\nA node in the configuration graph. A node represents a …\nNodeId is the unique identifier of a node in the …\nContains the success value\nHomebrewed Option<CuDuration> to avoid using 128bits just …\nRepresents a time range with possible undefined start or …\nCallbacked when a task is getting called on post-process.\nCallbacked when a task is getting called on pre-process.\nCallbacked when a task is getting called on process. I and …\nA running Robot clock. The clock is a monotonic clock that …\nA mock clock that can be controlled by the user.\nA simple struct that counts the number of bytes allocated …\nA SectionHandle is a handle to a section in the datalogger.\nEach concurrent sublogger is tracked through a section …\nThis is the answer the simulator can give to control the …\nThis allows this crate to be used outside of Copper (ie. …\nCallbacked when a task is started.\nCallbacked when a task is stopped.\nThe time of validity of a message can be more than one …\nDefines the types of what can be logged in the unified …\nHolder of the read or write side of the datalogger.\nUse this builder to create a new DataLogger.\nThis a convience wrapper around the UnifiedLoggerRead to …\nA read side of the datalogger.\nA write side of the datalogger.\nDefines a basic write, append only stream trait to be able …\nPanics\nAdd a new node to the configuration graph.\nAdd a parameter to the log entry. paramname_index is the …\nReturns an ascending iterator over the queue’s contents.\nReturns a mutable ascending iterator over the queue’s …\nTells Copper to batch messages before sending the buffer …\nReturns Some(t) where t is the time self + duration if t …\nReturns the amount of time elapsed from another instant to …\nReturns Some(t) where t is the time self - duration if t …\nClears the queue.\nThe base clock the runtime will be using to record time.\nThis is the main heuristics to compute an execution plan …\nThis module defines the configuration of the copper …\nAdds an edge between two nodes/tasks in the configuration …\nAdds an edge between two nodes/tasks in the configuration …\nCopper lists hold in order all the input/output messages …\nAdds #[copper_runtime(config = “path”, sim_mode = …\nCopperList is the main data structure used by Copper to …\nCuRuntime is the heart of what copper is running on the …\nThis module contains all the main definition of the traits …\nThis macro is used to log a message with parameters. The …\nDecrements the time by the given amount. Be careful this …\nConvenience function to returns the default path for the …\nThis is a custom serialization to make this implementation …\nReturns the amount of time elapsed from another instant to …\nReturns the amount of time elapsed since this instant was …\nIf “something/toto.copper” is given, it will find or …\nText log line formatter.\nThis method is called by the framework when it wants to …\nThis method is called by the framework when it wants to …\nThis method is called by the framework when it wants to …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nBuilds a monotonic clock starting at the given reference …\nGenerates the CopperList content type from a config. …\nConvenience method to get all nodes in the configuration …\nGet the list of edges that are connected to the given node …\nGet the node with the given id.\nthis is more like infer from the connections of this node.\nGet the node with the given id mutably.\nthis is more like infer from the connections of this node.\nGet the list of edges that are connected to the given node …\ndestination is the binary stream in which we will log the …\nthe indices in the copper list of the input messages and …\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nReturns true if the queue contains no elements.\nReturns true if the queue is full.\nReturns an iterator over the queue’s contents.\nReturns a mutable iterator over the queue’s contents.\nReturns the current number of elements in the queue.\nFunction called from generated code to log data. It moves …\nThis version of log is only compiled in debug mode This …\nThis metadata is the data that is common to all messages.\nBuild a fake clock with a reference time of 0. The …\nSome basic internal monitoring tooling Copper uses to …\nMessage type exchanged betwee src and dst.\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nmsg_index is the interned index of the message.\nCreates a RobotClock using now as its reference time. It …\nNode: node instance\nNodeId: node id of the task to execute\nGets the current time, scaled to reference time.\nA convenient way to get the current time from the mocking …\nthe index in the copper list of the output message and its …\nPeeks at the last element in the queue.\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nCallback that will be trigger at the end of every …\nCallbacked when a Task errored out. The runtime requires …\nThe time range used for the processing of this message\nRead a copper configuration from a file.\nRead a copper configuration from a file.\nRebuild the interned string index in memory.\nReads the section from the section header pos.\nRebuild a log line from the interned strings and the …\nGets the most recent current time, scaled to reference …\nAdds a value to the statistics.\nRender the configuration graph in the dot format.\nReturns the amount of time elapsed from another instant to …\nThis is a custom serialization to make this implementation …\nSets the absolute value of the time.\ncu29::simulation Module\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nA small string for real time feedback purposes. This is …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCallbacked when copper is stopping.\nCallbacked when copper is stopping.\nCallbacked when copper is stopping.\nTells Copper if it needs to log the messages.\nCreate a new stream to write to the unifiedlogger.\nReturns the amount of time elapsed from another instant to …\nCuTaskType: type of the task\nThe tuple of all the tasks in order of execution.\nThis method is called by the framework when it wants to …\nThis method is called by the framework when it wants to …\nThis method is called by the framework when it wants to …\nThe time of validity of the message. It can be undefined …\nGets the current value of time.\nThis represents a connection between 2 tasks (nodes) in …\nThis is the configuration of a component (like a task …\nCuConfig is the programmatic representation of the …\nA node in the configuration graph. A node represents a …\nNodeId is the unique identifier of a node in the …\nWrapper around the ron::Value to allow for custom …\nTells Copper to batch messages before sending the buffer …\nMessage type exchanged betwee src and dst.\nRead a copper configuration from a file.\nRead a copper configuration from a file.\nTells Copper if it needs to log the messages.\nNot implemented yet. This mask will be used to for example …\nThose are the possible states along the lifetime of a …\nThis structure maintains the entire memory needed by …\nJust a simple struct to hold the various bits needed to …\nThis structure represents a loop in the execution plan. It …\nThis structure represents a step in the execution plan.\nThis structure represents a step in the execution plan.\nThis is the main structure that will be injected as a …\nCopper tasks can be of 3 types:\nThe base clock the runtime will be using to record time.\nThis is the main heuristics to compute an execution plan …\nCopper lists hold in order all the input/output messages …\nthe indices in the copper list of the input messages and …\nNode: node instance\nNodeId: node id of the task to execute\nthe index in the copper list of the output message and its …\nCuTaskType: type of the task\nThe tuple of all the tasks in order of execution.\nCuMsg is the envelope holding the msg payload and the …\nCuMsgMetadata is a structure that contains metadata common …\nA Sink Task is a task that only consumes messages. For …\nA Src Task is a task that only produces messages. For …\nThis is the most generic Task of copper. It is a “…\nThe internal state of a task needs to be serializable so …\nThis metadata is the data that is common to all messages.\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nThe time range used for the processing of this message\nA small string for real time feedback purposes. This is …\nThe time of validity of the message. It can be undefined …\nA simple allocator that counts the number of bytes …\nA Specialized statistics object for CuDuration. It will …\nTrait to implement a monitoring task.\nThe state of a task.\nMonitor decision to be taken when a task errored out.\nAccumulative stat object that can give your some real time …\nA do nothing monitor if no monitor is provided. This is …\nA simple struct that counts the number of bytes allocated …\nCallback that will be trigger at the end of every …\nCallbacked when a Task errored out. The runtime requires …\nCopper friendly wrapper for a fixed size array.\nThis is a placeholder task for a sink task for the …\nThis is a placeholder task for a source task for the …\nThis is the state that will be passed to the simulation …\nEmulated the behavior of an erroring task (same as return …\nThe actual implementation needs to be executed.\nThe callback took care of the logic on the simulation side …\nCallbacked when a task is created. It gives you the …\nCallbacked when a task is getting called on post-process.\nCallbacked when a task is getting called on pre-process.\nCallbacked when a task is getting called on process. I and …\nThis is the answer the simulator can give to control the …\nCallbacked when a task is started.\nCallbacked when a task is stopped.\nThis is a placeholder task for a sink task for the …\nThis is a placeholder task for a source task for the …\nThis is the state that will be passed to the simulation …\nEmulated the behavior of an erroring task (same as return …\nThe actual implementation needs to be executed.\nThe callback took care of the logic on the simulation side …\nCallbacked when a task is created. It gives you the …\nCallbacked when a task is getting called on post-process.\nCallbacked when a task is getting called on pre-process.\nCallbacked when a task is getting called on process. I and …\nThis is the answer the simulator can give to control the …\nCallbacked when a task is started.\nCallbacked when a task is stopped.")
\ No newline at end of file
+searchState.loadedDescShard("cu29", 0, "A CopperListTuple needs to be encodable, decodable and …\nCommon copper Error type.\nContains the error value\nContains the success value\nDefines the types of what can be logged in the unified …\nDefines a basic write, append only stream trait to be able …\nThis module defines the configuration of the copper …\nCopperList is the main data structure used by Copper to …\nCuRuntime is the heart of what copper is running on the …\nThis module contains all the main definition of the traits …\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nSome basic internal monitoring tooling Copper uses to …\nRead a copper configuration from a file.\ncu29::simulation Module\nThis represents a connection between 2 tasks (nodes) in …\nThis is the configuration of a component (like a task …\nCuConfig is the programmatic representation of the …\nA node in the configuration graph. A node represents a …\nNodeId is the unique identifier of a node in the …\nWrapper around the ron::Value to allow for custom …\nTells Copper to batch messages before sending the buffer …\nReturns the argument unchanged.\nCalls U::from(self).\nMessage type exchanged between src and dst.\nRead a copper configuration from a file.\nRead a copper configuration from a file.\nTells Copper if it needs to log the messages.\nNot implemented yet. This mask will be used to for example …\nThose are the possible states along the lifetime of a …\nThis structure maintains the entire memory needed by …\nJust a simple struct to hold the various bits needed to …\nThis structure represents a loop in the execution plan. It …\nThis structure represents a step in the execution plan.\nThis structure represents a step in the execution plan.\nThis is the main structure that will be injected as a …\nCopper tasks can be of 3 types:\nThe base clock the runtime will be using to record time.\nThis is the main heuristics to compute an execution plan …\nCopper lists hold in order all the input/output messages …\nthe indices in the copper list of the input messages and …\nNode: node instance\nNodeId: node id of the task to execute\nthe index in the copper list of the output message and its …\nCuTaskType: type of the task\nThe tuple of all the tasks in order of execution.\nCuMsg is the envelope holding the msg payload and the …\nCuMsgMetadata is a structure that contains metadata common …\nA Sink Task is a task that only consumes messages. For …\nA Src Task is a task that only produces messages. For …\nThis is the most generic Task of copper. It is a “…\nThe internal state of a task needs to be serializable so …\nThis metadata is the data that is common to all messages.\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nThe time range used for the processing of this message\nA small string for real time feedback purposes. This is …\nThe time of validity of the message. It can be undefined …\nA simple allocator that counts the number of bytes …\nA Specialized statistics object for CuDuration. It will …\nTrait to implement a monitoring task.\nThe state of a task.\nMonitor decision to be taken when a task errored out.\nAccumulative stat object that can give your some real time …\nA do nothing monitor if no monitor is provided. This is …\nA simple struct that counts the number of bytes allocated …\nCallback that will be trigger at the end of every …\nCallbacked when a Task errored out. The runtime requires …\nCopper friendly wrapper for a fixed size array.\nA trait to provide a clock to the runtime.\nThis represents a connection between 2 tasks (nodes) in …\nThis is the configuration of a component (like a task …\nJust a simple struct to hold the various bits needed to …\nNot implemented yet. This mask will be used to for example …\nThose are the possible states along the lifetime of a …\nA CopperListTuple needs to be encodable, decodable and …\nA simple allocator that counts the number of bytes …\nCopper friendly wrapper for a fixed size array.\nCuConfig is the programmatic representation of the …\nFor Robot times, the underlying type is a u64 representing …\nA Specialized statistics object for CuDuration. It will …\nCommon copper Error type.\nThis structure represents a loop in the execution plan. It …\nThis structure represents a step in the execution plan.\nThis structure represents a step in the execution plan.\nThis structure maintains the entire memory needed by …\nThis is the basic structure for a log entry in Copper.\nTrait to implement a monitoring task.\nCuMsg is the envelope holding the msg payload and the …\nCuMsgMetadata is a structure that contains metadata common …\nThis is the main structure that will be injected as a …\nThis is a placeholder task for a sink task for the …\nThis is a placeholder task for a source task for the …\nA Sink Task is a task that only consumes messages. For …\nA Src Task is a task that only produces messages. For …\nThis is the most generic Task of copper. It is a “…\nThis is the state that will be passed to the simulation …\nThe state of a task.\nCopper tasks can be of 3 types:\nA robot time is just a duration from a fixed point in time.\nRepresents a time range.\nMonitor decision to be taken when a task errored out.\nContains the error value\nEmulated the behavior of an erroring task (same as return …\nThe actual implementation needs to be executed.\nThe callback took care of the logic on the simulation side …\nThe internal state of a task needs to be serializable so …\nA point-in-time wall-clock measurement.\nAccumulative stat object that can give your some real time …\nThe lifetime of this struct is the lifetime of the logger.\nCallbacked when a task is created. It gives you the …\nA do nothing monitor if no monitor is provided. This is …\nA node in the configuration graph. A node represents a …\nNodeId is the unique identifier of a node in the …\nContains the success value\nHomebrewed Option<CuDuration> to avoid using 128bits just …\nRepresents a time range with possible undefined start or …\nCallbacked when a task is getting called on post-process.\nCallbacked when a task is getting called on pre-process.\nCallbacked when a task is getting called on process. I and …\nA running Robot clock. The clock is a monotonic clock that …\nA mock clock that can be controlled by the user.\nA simple struct that counts the number of bytes allocated …\nA SectionHandle is a handle to a section in the datalogger.\nEach concurrent sublogger is tracked through a section …\nThis is the answer the simulator can give to control the …\nThis allows this crate to be used outside of Copper (ie. …\nCallbacked when a task is started.\nCallbacked when a task is stopped.\nThe time of validity of a message can be more than one …\nDefines the types of what can be logged in the unified …\nHolder of the read or write side of the datalogger.\nUse this builder to create a new DataLogger.\nThis a convenience wrapper around the UnifiedLoggerRead to …\nA read side of the datalogger.\nA write side of the datalogger.\nDefines a basic write, append only stream trait to be able …\nPanics\nAdd a new node to the configuration graph.\nAdd a parameter to the log entry. paramname_index is the …\nReturns an ascending iterator over the queue’s contents.\nReturns a mutable ascending iterator over the queue’s …\nTells Copper to batch messages before sending the buffer …\nReturns Some(t) where t is the time self + duration if t …\nReturns the amount of time elapsed from another instant to …\nReturns Some(t) where t is the time self - duration if t …\nClears the queue.\nThe base clock the runtime will be using to record time.\nThis is the main heuristics to compute an execution plan …\nThis module defines the configuration of the copper …\nAdds an edge between two nodes/tasks in the configuration …\nAdds an edge between two nodes/tasks in the configuration …\nCopper lists hold in order all the input/output messages …\nAdds #[copper_runtime(config = “path”, sim_mode = …\nCopperList is the main data structure used by Copper to …\nCuRuntime is the heart of what copper is running on the …\nThis module contains all the main definition of the traits …\nThis macro is used to log a message with parameters. The …\nDecrements the time by the given amount. Be careful this …\nConvenience function to returns the default path for the …\nThis is a custom serialization to make this implementation …\nReturns the amount of time elapsed from another instant to …\nReturns the amount of time elapsed since this instant was …\nIf “something/toto.copper” is given, it will find or …\nText log line formatter.\nThis method is called by the framework when it wants to …\nThis method is called by the framework when it wants to …\nThis method is called by the framework when it wants to …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nBuilds a monotonic clock starting at the given reference …\nGenerates the CopperList content type from a config. …\nConvenience method to get all nodes in the configuration …\nGet the list of edges that are connected to the given node …\nGet the node with the given id.\nthis is more like infer from the connections of this node.\nGet the node with the given id mutably.\nthis is more like infer from the connections of this node.\nGet the list of edges that are connected to the given node …\ndestination is the binary stream in which we will log the …\nthe indices in the copper list of the input messages and …\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nReturns true if the queue contains no elements.\nReturns true if the queue is full.\nReturns an iterator over the queue’s contents.\nReturns a mutable iterator over the queue’s contents.\nReturns the current number of elements in the queue.\nFunction called from generated code to log data. It moves …\nThis version of log is only compiled in debug mode This …\nThis metadata is the data that is common to all messages.\nBuild a fake clock with a reference time of 0. The …\nSome basic internal monitoring tooling Copper uses to …\nMessage type exchanged between src and dst.\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nmsg_index is the interned index of the message.\nCreates a RobotClock using now as its reference time. It …\nNode: node instance\nNodeId: node id of the task to execute\nGets the current time, scaled to reference time.\nA convenient way to get the current time from the mocking …\nthe index in the copper list of the output message and its …\nPeeks at the last element in the queue.\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nCallback that will be trigger at the end of every …\nCallbacked when a Task errored out. The runtime requires …\nThe time range used for the processing of this message\nRead a copper configuration from a file.\nRead a copper configuration from a file.\nRebuild the interned string index in memory.\nReads the section from the section header pos.\nRebuild a log line from the interned strings and the …\nGets the most recent current time, scaled to reference …\nAdds a value to the statistics.\nRender the configuration graph in the dot format.\nReturns the amount of time elapsed from another instant to …\nThis is a custom serialization to make this implementation …\nSets the absolute value of the time.\ncu29::simulation Module\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nA small string for real time feedback purposes. This is …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCallbacked when copper is stopping.\nCallbacked when copper is stopping.\nCallbacked when copper is stopping.\nTells Copper if it needs to log the messages.\nCreate a new stream to write to the unifiedlogger.\nReturns the amount of time elapsed from another instant to …\nCuTaskType: type of the task\nThe tuple of all the tasks in order of execution.\nThis method is called by the framework when it wants to …\nThis method is called by the framework when it wants to …\nThis method is called by the framework when it wants to …\nThe time of validity of the message. It can be undefined …\nGets the current value of time.\nThis represents a connection between 2 tasks (nodes) in …\nThis is the configuration of a component (like a task …\nCuConfig is the programmatic representation of the …\nA node in the configuration graph. A node represents a …\nNodeId is the unique identifier of a node in the …\nWrapper around the ron::Value to allow for custom …\nTells Copper to batch messages before sending the buffer …\nMessage type exchanged between src and dst.\nRead a copper configuration from a file.\nRead a copper configuration from a file.\nTells Copper if it needs to log the messages.\nNot implemented yet. This mask will be used to for example …\nThose are the possible states along the lifetime of a …\nThis structure maintains the entire memory needed by …\nJust a simple struct to hold the various bits needed to …\nThis structure represents a loop in the execution plan. It …\nThis structure represents a step in the execution plan.\nThis structure represents a step in the execution plan.\nThis is the main structure that will be injected as a …\nCopper tasks can be of 3 types:\nThe base clock the runtime will be using to record time.\nThis is the main heuristics to compute an execution plan …\nCopper lists hold in order all the input/output messages …\nthe indices in the copper list of the input messages and …\nNode: node instance\nNodeId: node id of the task to execute\nthe index in the copper list of the output message and its …\nCuTaskType: type of the task\nThe tuple of all the tasks in order of execution.\nCuMsg is the envelope holding the msg payload and the …\nCuMsgMetadata is a structure that contains metadata common …\nA Sink Task is a task that only consumes messages. For …\nA Src Task is a task that only produces messages. For …\nThis is the most generic Task of copper. It is a “…\nThe internal state of a task needs to be serializable so …\nThis metadata is the data that is common to all messages.\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nThe time range used for the processing of this message\nA small string for real time feedback purposes. This is …\nThe time of validity of the message. It can be undefined …\nA simple allocator that counts the number of bytes …\nA Specialized statistics object for CuDuration. It will …\nTrait to implement a monitoring task.\nThe state of a task.\nMonitor decision to be taken when a task errored out.\nAccumulative stat object that can give your some real time …\nA do nothing monitor if no monitor is provided. This is …\nA simple struct that counts the number of bytes allocated …\nCallback that will be trigger at the end of every …\nCallbacked when a Task errored out. The runtime requires …\nCopper friendly wrapper for a fixed size array.\nThis is a placeholder task for a sink task for the …\nThis is a placeholder task for a source task for the …\nThis is the state that will be passed to the simulation …\nEmulated the behavior of an erroring task (same as return …\nThe actual implementation needs to be executed.\nThe callback took care of the logic on the simulation side …\nCallbacked when a task is created. It gives you the …\nCallbacked when a task is getting called on post-process.\nCallbacked when a task is getting called on pre-process.\nCallbacked when a task is getting called on process. I and …\nThis is the answer the simulator can give to control the …\nCallbacked when a task is started.\nCallbacked when a task is stopped.\nThis is a placeholder task for a sink task for the …\nThis is a placeholder task for a source task for the …\nThis is the state that will be passed to the simulation …\nEmulated the behavior of an erroring task (same as return …\nThe actual implementation needs to be executed.\nThe callback took care of the logic on the simulation side …\nCallbacked when a task is created. It gives you the …\nCallbacked when a task is getting called on post-process.\nCallbacked when a task is getting called on pre-process.\nCallbacked when a task is getting called on process. I and …\nThis is the answer the simulator can give to control the …\nCallbacked when a task is started.\nCallbacked when a task is stopped.")
\ No newline at end of file
diff --git a/search.desc/cu29_rendercfg/cu29_rendercfg-desc-0-.js b/search.desc/cu29_rendercfg/cu29_rendercfg-desc-0-.js
index 63fab021f..919fa2845 100644
--- a/search.desc/cu29_rendercfg/cu29_rendercfg-desc-0-.js
+++ b/search.desc/cu29_rendercfg/cu29_rendercfg-desc-0-.js
@@ -1 +1 @@
-searchState.loadedDescShard("cu29_rendercfg", 0, "A CopperListTuple needs to be encodable, decodable and …\nCommon copper Error type.\nContains the error value\nContains the success value\nDefines the types of what can be logged in the unified …\nDefines a basic write, append only stream trait to be able …\nThis module defines the configuration of the copper …\nConfig file name\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nRender the configuration file to a dot file then convert …\nOpen the SVG in the default system viewer\nThis represents a connection between 2 tasks (nodes) in …\nThis is the configuration of a component (like a task …\nCuConfig is the programmatic representation of the …\nThe config is a list of tasks and their connections.\nA node in the configuration graph. A node represents a …\nNodeId is the unique identifier of a node in the …\nWrapper around the ron::Value to allow for custom …\nAdd a new node to the configuration graph.\nTells Copper to batch messages before sending the buffer …\nAdds an edge between two nodes/tasks in the configuration …\nAdds an edge between two nodes/tasks in the configuration …\nThis is a custom serialization to make this implementation …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nConvenience method to get all nodes in the configuration …\nGet the list of edges that are connected to the given node …\nGet the node with the given id.\nthis is more like infer from the connections of this node.\nGet the node with the given id mutably.\nthis is more like infer from the connections of this node.\nGet the list of edges that are connected to the given node …\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nMessage type exchanged betwee src and dst.\nRead a copper configuration from a file.\nRead a copper configuration from a file.\nRender the configuration graph in the dot format.\nThis is a custom serialization to make this implementation …\nSource node id.\nTells Copper if it needs to log the messages.")
\ No newline at end of file
+searchState.loadedDescShard("cu29_rendercfg", 0, "A CopperListTuple needs to be encodable, decodable and …\nCommon copper Error type.\nContains the error value\nContains the success value\nDefines the types of what can be logged in the unified …\nDefines a basic write, append only stream trait to be able …\nThis module defines the configuration of the copper …\nConfig file name\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nRender the configuration file to a dot file then convert …\nOpen the SVG in the default system viewer\nThis represents a connection between 2 tasks (nodes) in …\nThis is the configuration of a component (like a task …\nCuConfig is the programmatic representation of the …\nThe config is a list of tasks and their connections.\nA node in the configuration graph. A node represents a …\nNodeId is the unique identifier of a node in the …\nWrapper around the ron::Value to allow for custom …\nAdd a new node to the configuration graph.\nTells Copper to batch messages before sending the buffer …\nAdds an edge between two nodes/tasks in the configuration …\nAdds an edge between two nodes/tasks in the configuration …\nThis is a custom serialization to make this implementation …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nConvenience method to get all nodes in the configuration …\nGet the list of edges that are connected to the given node …\nGet the node with the given id.\nthis is more like infer from the connections of this node.\nGet the node with the given id mutably.\nthis is more like infer from the connections of this node.\nGet the list of edges that are connected to the given node …\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nMessage type exchanged between src and dst.\nRead a copper configuration from a file.\nRead a copper configuration from a file.\nRender the configuration graph in the dot format.\nThis is a custom serialization to make this implementation …\nSource node id.\nTells Copper if it needs to log the messages.")
\ No newline at end of file
diff --git a/search.desc/cu29_runtime/cu29_runtime-desc-0-.js b/search.desc/cu29_runtime/cu29_runtime-desc-0-.js
index 15f32f74b..a525a3a8a 100644
--- a/search.desc/cu29_runtime/cu29_runtime-desc-0-.js
+++ b/search.desc/cu29_runtime/cu29_runtime-desc-0-.js
@@ -1 +1 @@
-searchState.loadedDescShard("cu29_runtime", 0, "This module defines the configuration of the copper …\nCopperList is the main data structure used by Copper to …\nCuRuntime is the heart of what copper is running on the …\nThis module contains all the main definition of the traits …\nSome basic internal monitoring tooling Copper uses to …\ncu29::simulation Module\nThis represents a connection between 2 tasks (nodes) in …\nThis is the configuration of a component (like a task …\nCuConfig is the programmatic representation of the …\nA node in the configuration graph. A node represents a …\nNodeId is the unique identifier of a node in the …\nWrapper around the ron::Value to allow for custom …\nAdd a new node to the configuration graph.\nTells Copper to batch messages before sending the buffer …\nAdds an edge between two nodes/tasks in the configuration …\nAdds an edge between two nodes/tasks in the configuration …\nThis is a custom serialization to make this implementation …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nConvenience method to get all nodes in the configuration …\nGet the list of edges that are connected to the given node …\nGet the node with the given id.\nthis is more like infer from the connections of this node.\nGet the node with the given id mutably.\nthis is more like infer from the connections of this node.\nGet the list of edges that are connected to the given node …\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nMessage type exchanged betwee src and dst.\nRead a copper configuration from a file.\nRead a copper configuration from a file.\nRender the configuration graph in the dot format.\nThis is a custom serialization to make this implementation …\nTells Copper if it needs to log the messages.\nNot implemented yet. This mask will be used to for example …\nThose are the possible states along the lifetime of a …\nThis structure maintains the entire memory needed by …\nReturns an ascending iterator over the queue’s contents.\nReturns a mutable ascending iterator over the queue’s …\nClears the queue.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nReturns true if the queue contains no elements.\nReturns true if the queue is full.\nReturns an iterator over the queue’s contents.\nReturns a mutable iterator over the queue’s contents.\nReturns the current number of elements in the queue.\nPeeks at the last element in the queue.\nJust a simple struct to hold the various bits needed to …\nThis structure represents a loop in the execution plan. It …\nThis structure represents a step in the execution plan.\nThis structure represents a step in the execution plan.\nThis is the main structure that will be injected as a …\nCopper tasks can be of 3 types:\nThe base clock the runtime will be using to record time.\nThis is the main heuristics to compute an execution plan …\nCopper lists hold in order all the input/output messages …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nthe indices in the copper list of the input messages and …\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nNode: node instance\nNodeId: node id of the task to execute\nthe index in the copper list of the output message and its …\nCuTaskType: type of the task\nThe tuple of all the tasks in order of execution.\nCuMsg is the envelope holding the msg payload and the …\nCuMsgMetadata is a structure that contains metadata common …\nA Sink Task is a task that only consumes messages. For …\nA Src Task is a task that only produces messages. For …\nThis is the most generic Task of copper. It is a “…\nThe internal state of a task needs to be serializable so …\nThis method is called by the framework when it wants to …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nThis metadata is the data that is common to all messages.\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nThe time range used for the processing of this message\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nA small string for real time feedback purposes. This is …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nThis method is called by the framework when it wants to …\nThe time of validity of the message. It can be undefined …\nA simple allocator that counts the number of bytes …\nA Specialized statistics object for CuDuration. It will …\nTrait to implement a monitoring task.\nThe state of a task.\nMonitor decision to be taken when a task errored out.\nAccumulative stat object that can give your some real time …\nA do nothing monitor if no monitor is provided. This is …\nA simple struct that counts the number of bytes allocated …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCallback that will be trigger at the end of every …\nCallbacked when a Task errored out. The runtime requires …\nAdds a value to the statistics.\nCallbacked when copper is stopping.\nCopper friendly wrapper for a fixed size array.\nReturns the argument unchanged.\nCalls U::from(self).\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nThis is a placeholder task for a sink task for the …\nThis is a placeholder task for a source task for the …\nThis is the state that will be passed to the simulation …\nEmulated the behavior of an erroring task (same as return …\nThe actual implementation needs to be executed.\nThe callback took care of the logic on the simulation side …\nCallbacked when a task is created. It gives you the …\nCallbacked when a task is getting called on post-process.\nCallbacked when a task is getting called on pre-process.\nCallbacked when a task is getting called on process. I and …\nThis is the answer the simulator can give to control the …\nCallbacked when a task is started.\nCallbacked when a task is stopped.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).")
\ No newline at end of file
+searchState.loadedDescShard("cu29_runtime", 0, "This module defines the configuration of the copper …\nCopperList is the main data structure used by Copper to …\nCuRuntime is the heart of what copper is running on the …\nThis module contains all the main definition of the traits …\nSome basic internal monitoring tooling Copper uses to …\ncu29::simulation Module\nThis represents a connection between 2 tasks (nodes) in …\nThis is the configuration of a component (like a task …\nCuConfig is the programmatic representation of the …\nA node in the configuration graph. A node represents a …\nNodeId is the unique identifier of a node in the …\nWrapper around the ron::Value to allow for custom …\nAdd a new node to the configuration graph.\nTells Copper to batch messages before sending the buffer …\nAdds an edge between two nodes/tasks in the configuration …\nAdds an edge between two nodes/tasks in the configuration …\nThis is a custom serialization to make this implementation …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nConvenience method to get all nodes in the configuration …\nGet the list of edges that are connected to the given node …\nGet the node with the given id.\nthis is more like infer from the connections of this node.\nGet the node with the given id mutably.\nthis is more like infer from the connections of this node.\nGet the list of edges that are connected to the given node …\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nMessage type exchanged between src and dst.\nRead a copper configuration from a file.\nRead a copper configuration from a file.\nRender the configuration graph in the dot format.\nThis is a custom serialization to make this implementation …\nTells Copper if it needs to log the messages.\nNot implemented yet. This mask will be used to for example …\nThose are the possible states along the lifetime of a …\nThis structure maintains the entire memory needed by …\nReturns an ascending iterator over the queue’s contents.\nReturns a mutable ascending iterator over the queue’s …\nClears the queue.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nReturns true if the queue contains no elements.\nReturns true if the queue is full.\nReturns an iterator over the queue’s contents.\nReturns a mutable iterator over the queue’s contents.\nReturns the current number of elements in the queue.\nPeeks at the last element in the queue.\nJust a simple struct to hold the various bits needed to …\nThis structure represents a loop in the execution plan. It …\nThis structure represents a step in the execution plan.\nThis structure represents a step in the execution plan.\nThis is the main structure that will be injected as a …\nCopper tasks can be of 3 types:\nThe base clock the runtime will be using to record time.\nThis is the main heuristics to compute an execution plan …\nCopper lists hold in order all the input/output messages …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nthe indices in the copper list of the input messages and …\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nNode: node instance\nNodeId: node id of the task to execute\nthe index in the copper list of the output message and its …\nCuTaskType: type of the task\nThe tuple of all the tasks in order of execution.\nCuMsg is the envelope holding the msg payload and the …\nCuMsgMetadata is a structure that contains metadata common …\nA Sink Task is a task that only consumes messages. For …\nA Src Task is a task that only produces messages. For …\nThis is the most generic Task of copper. It is a “…\nThe internal state of a task needs to be serializable so …\nThis method is called by the framework when it wants to …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nThis metadata is the data that is common to all messages.\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nHere you need to initialize everything your task will need …\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime after “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nThis is a method called by the runtime before “process”…\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nProcess is the most critical execution of the task. The …\nThe time range used for the processing of this message\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nStart is called between the creation of the task and the …\nA small string for real time feedback purposes. This is …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nCalled to stop the task. It signals that the *process …\nThis method is called by the framework when it wants to …\nThe time of validity of the message. It can be undefined …\nA simple allocator that counts the number of bytes …\nA Specialized statistics object for CuDuration. It will …\nTrait to implement a monitoring task.\nThe state of a task.\nMonitor decision to be taken when a task errored out.\nAccumulative stat object that can give your some real time …\nA do nothing monitor if no monitor is provided. This is …\nA simple struct that counts the number of bytes allocated …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCallback that will be trigger at the end of every …\nCallbacked when a Task errored out. The runtime requires …\nAdds a value to the statistics.\nCallbacked when copper is stopping.\nCopper friendly wrapper for a fixed size array.\nReturns the argument unchanged.\nCalls U::from(self).\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nThis is a placeholder task for a sink task for the …\nThis is a placeholder task for a source task for the …\nThis is the state that will be passed to the simulation …\nEmulated the behavior of an erroring task (same as return …\nThe actual implementation needs to be executed.\nThe callback took care of the logic on the simulation side …\nCallbacked when a task is created. It gives you the …\nCallbacked when a task is getting called on post-process.\nCallbacked when a task is getting called on pre-process.\nCallbacked when a task is getting called on process. I and …\nThis is the answer the simulator can give to control the …\nCallbacked when a task is started.\nCallbacked when a task is stopped.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).")
\ No newline at end of file
diff --git a/search.desc/cu29_unifiedlog/cu29_unifiedlog-desc-0-.js b/search.desc/cu29_unifiedlog/cu29_unifiedlog-desc-0-.js
index 96e319a1d..ff02986f3 100644
--- a/search.desc/cu29_unifiedlog/cu29_unifiedlog-desc-0-.js
+++ b/search.desc/cu29_unifiedlog/cu29_unifiedlog-desc-0-.js
@@ -1 +1 @@
-searchState.loadedDescShard("cu29_unifiedlog", 0, "A SectionHandle is a handle to a section in the datalogger.\nEach concurrent sublogger is tracked through a section …\nHolder of the read or write side of the datalogger.\nUse this builder to create a new DataLogger.\nThis a convience wrapper around the UnifiedLoggerRead to …\nA read side of the datalogger.\nA write side of the datalogger.\nIf “something/toto.copper” is given, it will find or …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nReads the section from the section header pos.\nCreate a new stream to write to the unifiedlogger.")
\ No newline at end of file
+searchState.loadedDescShard("cu29_unifiedlog", 0, "A SectionHandle is a handle to a section in the datalogger.\nEach concurrent sublogger is tracked through a section …\nHolder of the read or write side of the datalogger.\nUse this builder to create a new DataLogger.\nThis a convenience wrapper around the UnifiedLoggerRead to …\nA read side of the datalogger.\nA write side of the datalogger.\nIf “something/toto.copper” is given, it will find or …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nCalls U::from(self).\nReads the section from the section header pos.\nCreate a new stream to write to the unifiedlogger.")
\ No newline at end of file
diff --git a/settings.html b/settings.html
index 8ca7e8732..3415ccc9e 100644
--- a/settings.html
+++ b/settings.html
@@ -1 +1 @@
-Settings
    Rustdoc settings
    Back
    
\ No newline at end of file
+Settings
    Rustdoc settings
    Back
    
\ No newline at end of file
diff --git a/src/cu29_clock/lib.rs.html b/src/cu29_clock/lib.rs.html
index bdc34614f..9676346cf 100644
--- a/src/cu29_clock/lib.rs.html
+++ b/src/cu29_clock/lib.rs.html
@@ -964,7 +964,7 @@
     }
 
     #[test]
-    fn longuest_duration() {
+    fn longest_duration() {
         let maxcu = CuDuration(u64::MAX);
         let maxd: Duration = maxcu.into();
         assert_eq!(maxd.as_nanos(), u64::MAX as u128);
diff --git a/src/cu29_derive/lib.rs.html b/src/cu29_derive/lib.rs.html
index f3d34e9a2..62a4b2e5f 100644
--- a/src/cu29_derive/lib.rs.html
+++ b/src/cu29_derive/lib.rs.html
@@ -1597,7 +1597,7 @@
 }
 
 /// Adds #[copper_runtime(config = "path", sim_mode = false/true)] to your application struct to generate the runtime.
-/// if sim_mode is ommited, it is set to false.
+/// if sim_mode is omitted, it is set to false.
 /// This will add a "runtime" field to your struct and implement the "new" and "run" methods.
 #[proc_macro_attribute]
 pub fn copper_runtime(args: TokenStream, input: TokenStream) -> TokenStream {
@@ -2382,9 +2382,9 @@
             #new {
                 let config_filename = #config_file;
                 let config = if config_override.is_some() {
-                    let overriden_config = config_override.unwrap();
-                    debug!("CuConfig: Overriden programmatically: {}", &overriden_config.serialize_ron());
-                    overriden_config
+                    let overridden_config = config_override.unwrap();
+                    debug!("CuConfig: Overridden programmatically: {}", &overridden_config.serialize_ron());
+                    overridden_config
                 } else if std::path::Path::new(config_filename).exists() {
                     debug!("CuConfig: Reading configuration from file: {}", config_filename);
                     _read_configuration(config_filename)?
diff --git a/src/cu29_log_derive/lib.rs.html b/src/cu29_log_derive/lib.rs.html
index 9efc526e6..f3c635f82 100644
--- a/src/cu29_log_derive/lib.rs.html
+++ b/src/cu29_log_derive/lib.rs.html
@@ -146,7 +146,7 @@
 /// debug!("a = {}, b = {}", my_value = a, b); // named and unnamed parameters
 /// ```
 ///
-/// You can retreive this data using the log_reader generated with your project and giving it the
+/// You can retrieve this data using the log_reader generated with your project and giving it the
 /// unified .copper log file and the string index file generated at compile time.
 ///
 /// Note: In debug mode, the log will also be printed to the console. (ie slooow).
diff --git a/src/cu29_rendercfg/config.rs.html b/src/cu29_rendercfg/config.rs.html
index 69bc9124e..e5ef00616 100644
--- a/src/cu29_rendercfg/config.rs.html
+++ b/src/cu29_rendercfg/config.rs.html
@@ -1001,7 +1001,7 @@
     // Destination node id.
     dst: String,
 
-    /// Message type exchanged betwee src and dst.
+    /// Message type exchanged between src and dst.
     pub msg: String,
 
     /// Tells Copper to batch messages before sending the buffer to the next node.
@@ -1143,7 +1143,7 @@
     }
 }
 
-/// The implementation has a lot of conveinence methods to manipulate
+/// The implementation has a lot of convenience methods to manipulate
 /// the configuration to give some flexibility into programmatically creating the configuration.
 impl CuConfig {
     /// Add a new node to the configuration graph.
diff --git a/src/cu29_runtime/config.rs.html b/src/cu29_runtime/config.rs.html
index db6d2127b..1f38fb846 100644
--- a/src/cu29_runtime/config.rs.html
+++ b/src/cu29_runtime/config.rs.html
@@ -1001,7 +1001,7 @@
     // Destination node id.
     dst: String,
 
-    /// Message type exchanged betwee src and dst.
+    /// Message type exchanged between src and dst.
     pub msg: String,
 
     /// Tells Copper to batch messages before sending the buffer to the next node.
@@ -1143,7 +1143,7 @@
     }
 }
 
-/// The implementation has a lot of conveinence methods to manipulate
+/// The implementation has a lot of convenience methods to manipulate
 /// the configuration to give some flexibility into programmatically creating the configuration.
 impl CuConfig {
     /// Add a new node to the configuration graph.
diff --git a/src/cu29_runtime/curuntime.rs.html b/src/cu29_runtime/curuntime.rs.html
index eccbba45c..fda9326d7 100644
--- a/src/cu29_runtime/curuntime.rs.html
+++ b/src/cu29_runtime/curuntime.rs.html
@@ -906,7 +906,7 @@
 }
 
 /// This is the main heuristics to compute an execution plan at compilation time.
-/// TODO: Make that heuristic plugable.
+/// TODO: Make that heuristic pluggable.
 pub fn compute_runtime_plan(config: &CuConfig) -> CuResult<CuExecutionLoop> {
     // find all the sources.
     let nodes_to_visit = config
@@ -1009,7 +1009,7 @@
     }
 
     #[test]
-    fn test_runtime_instanciation() {
+    fn test_runtime_instantiation() {
         let mut config = CuConfig::default();
         config.add_node(Node::new("a", "TestSource"));
         config.add_node(Node::new("b", "TestSink"));
diff --git a/src/cu29_runtime/cutask.rs.html b/src/cu29_runtime/cutask.rs.html
index b1818c412..d865c1fc8 100644
--- a/src/cu29_runtime/cutask.rs.html
+++ b/src/cu29_runtime/cutask.rs.html
@@ -378,7 +378,7 @@
     (T1, T2), (T1, T2, T3), (T1, T2, T3, T4), (T1, T2, T3, T4, T5) // TODO: continue if necessary
 }
 
-// A convience macro to get from a payload or a list of payloads to a proper CuMsg or CuMsgPack
+// A convenience macro to get from a payload or a list of payloads to a proper CuMsg or CuMsgPack
 // declaration for your tasks used for input messages.
 #[macro_export]
 macro_rules! input_msg {
@@ -392,7 +392,7 @@
     };
 }
 
-// A convience macro to get from a payload to a proper CuMsg used as output.
+// A convenience macro to get from a payload to a proper CuMsg used as output.
 #[macro_export]
 macro_rules! output_msg {
     ($lifetime:lifetime, $ty:ty) => {
@@ -438,7 +438,7 @@
     /// It can be undefined (None), one measure point or a range of measures (TimeRange).
     pub tov: Tov,
     /// A small string for real time feedback purposes.
-    /// This is usefull for to display on the field when the tasks are operating correctly.
+    /// This is useful for to display on the field when the tasks are operating correctly.
     pub status_txt: CuCompactString,
 }
 
@@ -509,7 +509,7 @@
 }
 
 /// The internal state of a task needs to be serializable
-/// so the framework can take a snapshop of the task graph.
+/// so the framework can take a snapshot of the task graph.
 pub trait Freezable {
     /// This method is called by the framework when it wants to save the task state.
     /// The default implementation is to encode nothing (stateless).
@@ -529,7 +529,7 @@
 /// A Src Task is a task that only produces messages. For example drivers for sensors are Src Tasks.
 /// They are in push mode from the runtime.
 /// To set the frequency of the pulls and align them to any hw, see the runtime configuration.
-/// Note: A source has the priviledge to have a clock passed to it vs a frozen clock.
+/// Note: A source has the privilege to have a clock passed to it vs a frozen clock.
 pub trait CuSrcTask<'cl>: Freezable {
     type Output: CuMsgPack<'cl>;
 
diff --git a/src/cu29_traits/lib.rs.html b/src/cu29_traits/lib.rs.html
index ccf5b8ffe..7b66fbc27 100644
--- a/src/cu29_traits/lib.rs.html
+++ b/src/cu29_traits/lib.rs.html
@@ -151,7 +151,7 @@
 /// Defines the types of what can be logged in the unified logger.
 #[derive(dEncode, dDecode, Copy, Clone, Debug, PartialEq)]
 pub enum UnifiedLogType {
-    Empty,             // Dummmy default used as a debug marker
+    Empty,             // Dummy default used as a debug marker
     StructuredLogLine, // This is for the structured logs (ie. debug! etc..)
     CopperList,        // This is the actual data log storing activities between tasks.
     LastEntry,         // This is a special entry that is used to signal the end of the log.
diff --git a/src/cu29_unifiedlog/lib.rs.html b/src/cu29_unifiedlog/lib.rs.html
index 99882facf..106fd781e 100644
--- a/src/cu29_unifiedlog/lib.rs.html
+++ b/src/cu29_unifiedlog/lib.rs.html
@@ -1346,7 +1346,7 @@
     }
 
     /// Flush the section to disk.
-    /// the flushing is permament and the section is considered closed.
+    /// the flushing is permanent and the section is considered closed.
     fn flush_section(&mut self, section: &mut SectionHandle) {
         if section.buffer.as_ptr() < self.mmap_buffer.as_ptr()
             || section.buffer.as_ptr() as usize
@@ -1742,7 +1742,7 @@
     }
 }
 
-/// This a convience wrapper around the UnifiedLoggerRead to implement the Read trait.
+/// This a convenience wrapper around the UnifiedLoggerRead to implement the Read trait.
 pub struct UnifiedLoggerIOReader {
     logger: UnifiedLoggerRead,
     log_type: UnifiedLogType,