diff --git a/cu29/all.html b/cu29/all.html index e3a94ce3e..0261e144d 100644 --- a/cu29/all.html +++ b/cu29/all.html @@ -1 +1 @@ -List of all items in this crate

List of all items

Structs

Enums

Traits

Macros

Attribute Macros

Functions

Type Aliases

Statics

Constants

\ No newline at end of file +List of all items in this crate

List of all items

Structs

Enums

Traits

Macros

Attribute Macros

Functions

Type Aliases

Statics

Constants

\ No newline at end of file diff --git a/cu29/config/fn.read_configuration.html b/cu29/config/fn.read_configuration.html index 4f498c57d..9a24d9f3d 100644 --- a/cu29/config/fn.read_configuration.html +++ b/cu29/config/fn.read_configuration.html @@ -1,2 +1,2 @@ -read_configuration in cu29::config - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a file.

+read_configuration in cu29::config - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a file.

\ No newline at end of file diff --git a/cu29/config/fn.read_configuration_str.html b/cu29/config/fn.read_configuration_str.html index a7cfc5073..181720bfd 100644 --- a/cu29/config/fn.read_configuration_str.html +++ b/cu29/config/fn.read_configuration_str.html @@ -1,4 +1,4 @@ -read_configuration_str in cu29::config - Rust

Function read_configuration_str

Source
pub fn read_configuration_str(
+read_configuration_str in cu29::config - Rust

Function read_configuration_str

Source
pub fn read_configuration_str(
     config_content: String,
 ) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a String.

\ No newline at end of file diff --git a/cu29/config/index.html b/cu29/config/index.html index b1119c7fd..246d4960b 100644 --- a/cu29/config/index.html +++ b/cu29/config/index.html @@ -1,4 +1,4 @@ -cu29::config - Rust

Module config

Source
Expand description

This module defines the configuration of the copper runtime. +cu29::config - Rust

Module config

Source
Expand description

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

diff --git a/cu29/config/struct.Cnx.html b/cu29/config/struct.Cnx.html index d6f034400..ef89d6d4e 100644 --- a/cu29/config/struct.Cnx.html +++ b/cu29/config/struct.Cnx.html @@ -1,4 +1,4 @@ -Cnx in cu29::config - Rust

Struct Cnx

Source
pub struct Cnx {
+Cnx in cu29::config - Rust

Struct Cnx

Source
pub struct Cnx {
     pub msg: String,
     pub batch: Option<u32>,
     pub store: Option<bool>,
diff --git a/cu29/config/struct.ComponentConfig.html b/cu29/config/struct.ComponentConfig.html
index bd9dde43c..4c1791500 100644
--- a/cu29/config/struct.ComponentConfig.html
+++ b/cu29/config/struct.ComponentConfig.html
@@ -1,4 +1,4 @@
-ComponentConfig in cu29::config - Rust

Struct ComponentConfig

Source
pub struct ComponentConfig(pub HashMap<String, Value>);
Expand description

This is the configuration of a component (like a task config or a monitoring config):w +ComponentConfig in cu29::config - Rust

Struct ComponentConfig

Source
pub struct ComponentConfig(pub HashMap<String, Value>);
Expand description

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

Tuple Fields§

§0: HashMap<String, Value>

Implementations§

Source§

impl ComponentConfig

Source

pub fn new() -> ComponentConfig

Source

pub fn get<T>(&self, key: &str) -> Option<T>
where diff --git a/cu29/config/struct.CuConfig.html b/cu29/config/struct.CuConfig.html index 215bb8afc..b5ed960f8 100644 --- a/cu29/config/struct.CuConfig.html +++ b/cu29/config/struct.CuConfig.html @@ -1,4 +1,4 @@ -CuConfig in cu29::config - Rust

Struct CuConfig

Source
pub struct CuConfig {
+CuConfig in cu29::config - Rust

Struct CuConfig

Source
pub struct CuConfig {
     pub graph: StableGraph<Node, Cnx>,
     pub monitor: Option<MonitorConfig>,
     pub logging: Option<LoggingConfig>,
diff --git a/cu29/config/struct.LoggingConfig.html b/cu29/config/struct.LoggingConfig.html
index de8cff9a3..3879fa675 100644
--- a/cu29/config/struct.LoggingConfig.html
+++ b/cu29/config/struct.LoggingConfig.html
@@ -1,4 +1,4 @@
-LoggingConfig in cu29::config - Rust

Struct LoggingConfig

Source
pub struct LoggingConfig {
+LoggingConfig in cu29::config - Rust

Struct LoggingConfig

Source
pub struct LoggingConfig {
     pub slab_size_mib: Option<u64>,
     pub section_size_mib: Option<u64>,
     pub enable_task_logging: bool,
diff --git a/cu29/config/struct.MonitorConfig.html b/cu29/config/struct.MonitorConfig.html
index fa2f024c5..cb4d8f8ce 100644
--- a/cu29/config/struct.MonitorConfig.html
+++ b/cu29/config/struct.MonitorConfig.html
@@ -1,4 +1,4 @@
-MonitorConfig in cu29::config - Rust

Struct MonitorConfig

Source
pub struct MonitorConfig { /* private fields */ }

Implementations§

Trait Implementations§

Source§

impl Clone for MonitorConfig

Source§

fn clone(&self) -> MonitorConfig

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 MonitorConfig

Source§

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

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

impl Default for MonitorConfig

Source§

fn default() -> MonitorConfig

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

impl<'de> Deserialize<'de> for MonitorConfig

Source§

fn deserialize<__D>( +MonitorConfig in cu29::config - Rust

Struct MonitorConfig

Source
pub struct MonitorConfig { /* private fields */ }

Implementations§

Trait Implementations§

Source§

impl Clone for MonitorConfig

Source§

fn clone(&self) -> MonitorConfig

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 MonitorConfig

Source§

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

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

impl Default for MonitorConfig

Source§

fn default() -> MonitorConfig

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

impl<'de> Deserialize<'de> for MonitorConfig

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<MonitorConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MonitorConfig

Source§

fn serialize<__S>( diff --git a/cu29/config/struct.Node.html b/cu29/config/struct.Node.html index cb95db6a4..d6de2911b 100644 --- a/cu29/config/struct.Node.html +++ b/cu29/config/struct.Node.html @@ -1,4 +1,4 @@ -Node in cu29::config - Rust

Struct Node

Source
pub struct Node { /* private fields */ }
Expand description

A node in the configuration graph. +Node in cu29::config - Rust

Struct Node

Source
pub struct Node { /* private fields */ }
Expand description

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

Implementations§

Source§

impl Node

Source

pub fn new(id: &str, ptype: &str) -> Node

Source

pub fn get_id(&self) -> String

Source

pub fn set_type(self, name: Option<String>) -> Node

Source

pub fn get_type(&self) -> &str

Source

pub fn get_instance_config(&self) -> Option<&ComponentConfig>

Source

pub fn get_param<T>(&self, key: &str) -> Option<T>
where T: From<Value>,

Source

pub fn set_param<T>(&mut self, key: &str, value: T)
where diff --git a/cu29/config/struct.Value.html b/cu29/config/struct.Value.html index 8ba0dacde..31d037a32 100644 --- a/cu29/config/struct.Value.html +++ b/cu29/config/struct.Value.html @@ -1,4 +1,4 @@ -Value in cu29::config - Rust

Struct Value

Source
pub struct Value(/* private fields */);
Expand description

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

+Value in cu29::config - Rust

Struct Value

Source
pub struct Value(/* private fields */);
Expand description

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

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

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 Value

Source§

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

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

impl<'de> Deserialize<'de> for Value

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Value, <__D as Deserializer<'de>>::Error>
where diff --git a/cu29/config/type.NodeId.html b/cu29/config/type.NodeId.html index 2755a0995..0379cd159 100644 --- a/cu29/config/type.NodeId.html +++ b/cu29/config/type.NodeId.html @@ -1,3 +1,3 @@ -NodeId in cu29::config - Rust

Type Alias NodeId

Source
pub type NodeId = u32;
Expand description

NodeId is the unique identifier of a node in the configuration graph for petgraph +NodeId in cu29::config - Rust

Type Alias NodeId

Source
pub type NodeId = u32;
Expand description

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

\ No newline at end of file diff --git a/cu29/copperlist/enum.CopperListState.html b/cu29/copperlist/enum.CopperListState.html index 93b1d16f9..6955c0186 100644 --- a/cu29/copperlist/enum.CopperListState.html +++ b/cu29/copperlist/enum.CopperListState.html @@ -1,4 +1,4 @@ -CopperListState in cu29::copperlist - Rust

Enum CopperListState

Source
pub enum CopperListState {
+CopperListState in cu29::copperlist - Rust

Enum CopperListState

Source
pub enum CopperListState {
     Free,
     Initialized,
     Processing,
diff --git a/cu29/copperlist/index.html b/cu29/copperlist/index.html
index 41e533872..6817e9498 100644
--- a/cu29/copperlist/index.html
+++ b/cu29/copperlist/index.html
@@ -1,4 +1,4 @@
-cu29::copperlist - Rust

Module copperlist

Source
Expand description

CopperList is the main data structure used by Copper to communicate between tasks. +cu29::copperlist - Rust

Module copperlist

Source
Expand description

CopperList is the main data structure used by Copper to communicate between tasks. It is a queue that can be used to store preallocated messages between tasks in memory order.

Structs§

CopperLiskMask
Not implemented yet. This mask will be used to for example filter out necessary regions of a copper list between remote systems.
CopperList
CuListsManager
This structure maintains the entire memory needed by Copper for one loop for the inter tasks communication within a process. diff --git a/cu29/copperlist/struct.CopperLiskMask.html b/cu29/copperlist/struct.CopperLiskMask.html index 73d514d58..2e0e07184 100644 --- a/cu29/copperlist/struct.CopperLiskMask.html +++ b/cu29/copperlist/struct.CopperLiskMask.html @@ -1,4 +1,4 @@ -CopperLiskMask in cu29::copperlist - Rust

Struct CopperLiskMask

Source
pub struct CopperLiskMask { /* private fields */ }
Expand description

Not implemented yet. +CopperLiskMask in cu29::copperlist - Rust

Struct CopperLiskMask

Source
pub struct CopperLiskMask { /* private fields */ }
Expand description

Not implemented yet. This mask will be used to for example filter out necessary regions of a copper list between remote systems.

Trait Implementations§

Source§

impl<'__de> BorrowDecode<'__de> for CopperLiskMask

Source§

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

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

impl Clone for CopperLiskMask

Source§

fn clone(&self) -> CopperLiskMask

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 CopperLiskMask

Source§

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

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

impl Decode for CopperLiskMask

Source§

fn decode<__D>(decoder: &mut __D) -> Result<CopperLiskMask, DecodeError>
where diff --git a/cu29/copperlist/struct.CopperList.html b/cu29/copperlist/struct.CopperList.html index 84ada511a..7f32b257a 100644 --- a/cu29/copperlist/struct.CopperList.html +++ b/cu29/copperlist/struct.CopperList.html @@ -1,4 +1,4 @@ -CopperList in cu29::copperlist - Rust

Struct CopperList

Source
pub struct CopperList<P>
where +CopperList in cu29::copperlist - Rust

Struct CopperList

Source
pub struct CopperList<P>
where P: CopperListTuple,
{ pub id: u32, pub msgs: P, diff --git a/cu29/copperlist/struct.CuListsManager.html b/cu29/copperlist/struct.CuListsManager.html index 786ef46f9..ba994856d 100644 --- a/cu29/copperlist/struct.CuListsManager.html +++ b/cu29/copperlist/struct.CuListsManager.html @@ -1,4 +1,4 @@ -CuListsManager in cu29::copperlist - Rust

Struct CuListsManager

Source
pub struct CuListsManager<P, const N: usize>
where +CuListsManager in cu29::copperlist - Rust

Struct CuListsManager

Source
pub struct CuListsManager<P, const N: usize>
where P: CopperListTuple,
{ /* private fields */ }
Expand description

This structure maintains the entire memory needed by Copper for one loop for the inter tasks communication within a process. P or Payload is typically a Tuple of various types of messages that are exchanged between tasks. N is the maximum number of in flight Copper List the runtime can support.

diff --git a/cu29/copperlist/type.AscIter.html b/cu29/copperlist/type.AscIter.html index 6b1e539ac..fbfdda38e 100644 --- a/cu29/copperlist/type.AscIter.html +++ b/cu29/copperlist/type.AscIter.html @@ -1 +1 @@ -AscIter in cu29::copperlist - Rust

Type Alias AscIter

Source
pub type AscIter<'a, T> = Chain<Iter<'a, T>, Iter<'a, T>>;

Aliased Type§

struct AscIter<'a, T> { /* private fields */ }
\ No newline at end of file +AscIter in cu29::copperlist - Rust

Type Alias AscIter

Source
pub type AscIter<'a, T> = Chain<Iter<'a, T>, Iter<'a, T>>;

Aliased Type§

struct AscIter<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/copperlist/type.AscIterMut.html b/cu29/copperlist/type.AscIterMut.html index cf0dbf6f5..dab196e44 100644 --- a/cu29/copperlist/type.AscIterMut.html +++ b/cu29/copperlist/type.AscIterMut.html @@ -1 +1 @@ -AscIterMut in cu29::copperlist - Rust

Type Alias AscIterMut

Source
pub type AscIterMut<'a, T> = Chain<IterMut<'a, T>, IterMut<'a, T>>;

Aliased Type§

struct AscIterMut<'a, T> { /* private fields */ }
\ No newline at end of file +AscIterMut in cu29::copperlist - Rust

Type Alias AscIterMut

Source
pub type AscIterMut<'a, T> = Chain<IterMut<'a, T>, IterMut<'a, T>>;

Aliased Type§

struct AscIterMut<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/copperlist/type.Iter.html b/cu29/copperlist/type.Iter.html index e5b70083f..b46011a6b 100644 --- a/cu29/copperlist/type.Iter.html +++ b/cu29/copperlist/type.Iter.html @@ -1 +1 @@ -Iter in cu29::copperlist - Rust

Type Alias Iter

Source
pub type Iter<'a, T> = Chain<Rev<Iter<'a, T>>, Rev<Iter<'a, T>>>;

Aliased Type§

struct Iter<'a, T> { /* private fields */ }
\ No newline at end of file +Iter in cu29::copperlist - Rust

Type Alias Iter

Source
pub type Iter<'a, T> = Chain<Rev<Iter<'a, T>>, Rev<Iter<'a, T>>>;

Aliased Type§

struct Iter<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/copperlist/type.IterMut.html b/cu29/copperlist/type.IterMut.html index 21f1e319e..96486b84f 100644 --- a/cu29/copperlist/type.IterMut.html +++ b/cu29/copperlist/type.IterMut.html @@ -1 +1 @@ -IterMut in cu29::copperlist - Rust

Type Alias IterMut

Source
pub type IterMut<'a, T> = Chain<Rev<IterMut<'a, T>>, Rev<IterMut<'a, T>>>;

Aliased Type§

struct IterMut<'a, T> { /* private fields */ }
\ No newline at end of file +IterMut in cu29::copperlist - Rust

Type Alias IterMut

Source
pub type IterMut<'a, T> = Chain<Rev<IterMut<'a, T>>, Rev<IterMut<'a, T>>>;

Aliased Type§

struct IterMut<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/curuntime/enum.CuExecutionUnit.html b/cu29/curuntime/enum.CuExecutionUnit.html index 9630175cc..915ab42bf 100644 --- a/cu29/curuntime/enum.CuExecutionUnit.html +++ b/cu29/curuntime/enum.CuExecutionUnit.html @@ -1,4 +1,4 @@ -CuExecutionUnit in cu29::curuntime - Rust

Enum CuExecutionUnit

Source
pub enum CuExecutionUnit {
+CuExecutionUnit in cu29::curuntime - Rust

Enum CuExecutionUnit

Source
pub enum CuExecutionUnit {
     Step(CuExecutionStep),
     Loop(CuExecutionLoop),
 }
Expand description

This structure represents a step in the execution plan.

diff --git a/cu29/curuntime/enum.CuTaskType.html b/cu29/curuntime/enum.CuTaskType.html index cfb669eaf..da0708780 100644 --- a/cu29/curuntime/enum.CuTaskType.html +++ b/cu29/curuntime/enum.CuTaskType.html @@ -1,4 +1,4 @@ -CuTaskType in cu29::curuntime - Rust

Enum CuTaskType

Source
pub enum CuTaskType {
+CuTaskType in cu29::curuntime - Rust

Enum CuTaskType

Source
pub enum CuTaskType {
     Source,
     Regular,
     Sink,
diff --git a/cu29/curuntime/fn.compute_runtime_plan.html b/cu29/curuntime/fn.compute_runtime_plan.html
index b04364474..b4d1f6db0 100644
--- a/cu29/curuntime/fn.compute_runtime_plan.html
+++ b/cu29/curuntime/fn.compute_runtime_plan.html
@@ -1,4 +1,4 @@
-compute_runtime_plan in cu29::curuntime - Rust

Function compute_runtime_plan

Source
pub fn compute_runtime_plan(
+compute_runtime_plan in cu29::curuntime - Rust

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 pluggable.

diff --git a/cu29/curuntime/fn.find_task_type_for_id.html b/cu29/curuntime/fn.find_task_type_for_id.html index fb4ed5c88..9cf67caa7 100644 --- a/cu29/curuntime/fn.find_task_type_for_id.html +++ b/cu29/curuntime/fn.find_task_type_for_id.html @@ -1,4 +1,4 @@ -find_task_type_for_id in cu29::curuntime - Rust

Function find_task_type_for_id

Source
pub fn find_task_type_for_id(
+find_task_type_for_id in cu29::curuntime - Rust

Function find_task_type_for_id

Source
pub fn find_task_type_for_id(
     graph: &StableGraph<Node, Cnx>,
     node_id: u32,
 ) -> CuTaskType
\ No newline at end of file diff --git a/cu29/curuntime/index.html b/cu29/curuntime/index.html index f88d90c9c..51d0751a9 100644 --- a/cu29/curuntime/index.html +++ b/cu29/curuntime/index.html @@ -1,4 +1,4 @@ -cu29::curuntime - Rust

Module curuntime

Source
Expand description

CuRuntime is the heart of what copper is running on the robot. +cu29::curuntime - Rust

Module curuntime

Source
Expand description

CuRuntime is the heart of what copper is running on the robot. It is exposed to the user via the copper_runtime macro injecting it as a field in their application struct.

Structs§

CopperContext
Just a simple struct to hold the various bits needed to run a Copper application.
CuExecutionLoop
This structure represents a loop in the execution plan. It is used to represent a sequence of Execution units (loop or steps) that are executed diff --git a/cu29/curuntime/struct.CopperContext.html b/cu29/curuntime/struct.CopperContext.html index a47761a9a..8177f7ad1 100644 --- a/cu29/curuntime/struct.CopperContext.html +++ b/cu29/curuntime/struct.CopperContext.html @@ -1,4 +1,4 @@ -CopperContext in cu29::curuntime - Rust

Struct CopperContext

Source
pub struct CopperContext {
+CopperContext in cu29::curuntime - Rust

Struct CopperContext

Source
pub struct CopperContext {
     pub unified_logger: Arc<Mutex<UnifiedLoggerWrite>>,
     pub logger_runtime: LoggerRuntime,
     pub clock: RobotClock,
diff --git a/cu29/curuntime/struct.CuExecutionLoop.html b/cu29/curuntime/struct.CuExecutionLoop.html
index 16e02d395..58543ddc4 100644
--- a/cu29/curuntime/struct.CuExecutionLoop.html
+++ b/cu29/curuntime/struct.CuExecutionLoop.html
@@ -1,4 +1,4 @@
-CuExecutionLoop in cu29::curuntime - Rust

Struct CuExecutionLoop

Source
pub struct CuExecutionLoop {
+CuExecutionLoop in cu29::curuntime - Rust

Struct CuExecutionLoop

Source
pub struct CuExecutionLoop {
     pub steps: Vec<CuExecutionUnit>,
     pub loop_count: Option<u32>,
 }
Expand description

This structure represents a loop in the execution plan. diff --git a/cu29/curuntime/struct.CuExecutionStep.html b/cu29/curuntime/struct.CuExecutionStep.html index 990262226..355739208 100644 --- a/cu29/curuntime/struct.CuExecutionStep.html +++ b/cu29/curuntime/struct.CuExecutionStep.html @@ -1,4 +1,4 @@ -CuExecutionStep in cu29::curuntime - Rust

Struct CuExecutionStep

Source
pub struct CuExecutionStep {
+CuExecutionStep in cu29::curuntime - Rust

Struct CuExecutionStep

Source
pub struct CuExecutionStep {
     pub node_id: u32,
     pub node: Node,
     pub task_type: CuTaskType,
diff --git a/cu29/curuntime/struct.CuRuntime.html b/cu29/curuntime/struct.CuRuntime.html
index da0159244..c9c0cf60c 100644
--- a/cu29/curuntime/struct.CuRuntime.html
+++ b/cu29/curuntime/struct.CuRuntime.html
@@ -1,4 +1,4 @@
-CuRuntime in cu29::curuntime - Rust

Struct CuRuntime

Source
pub struct CuRuntime<CT, P, M, const NBCL: usize>
where +CuRuntime in cu29::curuntime - Rust

Struct CuRuntime

Source
pub struct CuRuntime<CT, P, M, const NBCL: usize>{
     pub tasks: CT,
diff --git a/cu29/cutask/index.html b/cu29/cutask/index.html
index 4009abb3e..44d0412fc 100644
--- a/cu29/cutask/index.html
+++ b/cu29/cutask/index.html
@@ -1,4 +1,4 @@
-cu29::cutask - Rust

Module cutask

Source
Expand description

This module contains all the main definition of the traits you need to implement +cu29::cutask - Rust

Module cutask

Source
Expand description

This module contains all the main definition of the traits you need to implement or interact with to create a Copper task.

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. diff --git a/cu29/cutask/struct.CuCompactString.html b/cu29/cutask/struct.CuCompactString.html index df37aa571..ae9fa5ffc 100644 --- a/cu29/cutask/struct.CuCompactString.html +++ b/cu29/cutask/struct.CuCompactString.html @@ -1,4 +1,4 @@ -CuCompactString in cu29::cutask - Rust

Struct CuCompactString

Source
pub struct CuCompactString(pub CompactString);

Tuple Fields§

§0: CompactString

Trait Implementations§

Source§

impl<'de> BorrowDecode<'de> for CuCompactString

Source§

fn borrow_decode<D>(decoder: &mut D) -> Result<CuCompactString, DecodeError>
where +CuCompactString in cu29::cutask - Rust

Struct CuCompactString

Source
pub struct CuCompactString(pub CompactString);

Tuple Fields§

§0: CompactString

Trait Implementations§

Source§

impl<'de> BorrowDecode<'de> for CuCompactString

Source§

fn borrow_decode<D>(decoder: &mut D) -> Result<CuCompactString, DecodeError>
where D: BorrowDecoder<'de>,

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

impl Clone for CuCompactString

Source§

fn clone(&self) -> CuCompactString

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 CuCompactString

Source§

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

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

impl Decode for CuCompactString

Source§

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

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

impl Default for CuCompactString

Source§

fn default() -> CuCompactString

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

impl<'de> Deserialize<'de> for CuCompactString

Source§

fn deserialize<__D>( __deserializer: __D, diff --git a/cu29/cutask/struct.CuMsg.html b/cu29/cutask/struct.CuMsg.html index d03055a5a..b6c0d72d8 100644 --- a/cu29/cutask/struct.CuMsg.html +++ b/cu29/cutask/struct.CuMsg.html @@ -1,4 +1,4 @@ -CuMsg in cu29::cutask - Rust

Struct CuMsg

Source
pub struct CuMsg<T>
where +CuMsg in cu29::cutask - Rust

Struct CuMsg

Source
pub struct CuMsg<T>
where T: CuMsgPayload,
{ pub metadata: CuMsgMetadata, /* private fields */ diff --git a/cu29/cutask/struct.CuMsgMetadata.html b/cu29/cutask/struct.CuMsgMetadata.html index 58fe2ca77..1a9be76f5 100644 --- a/cu29/cutask/struct.CuMsgMetadata.html +++ b/cu29/cutask/struct.CuMsgMetadata.html @@ -1,4 +1,4 @@ -CuMsgMetadata in cu29::cutask - Rust

Struct CuMsgMetadata

Source
pub struct CuMsgMetadata {
+CuMsgMetadata in cu29::cutask - Rust

Struct CuMsgMetadata

Source
pub struct CuMsgMetadata {
     pub process_time: PartialCuTimeRange,
     pub tov: Tov,
     pub status_txt: CuCompactString,
diff --git a/cu29/cutask/trait.CuMsgPack.html b/cu29/cutask/trait.CuMsgPack.html
index 650bcf06c..33ad44205 100644
--- a/cu29/cutask/trait.CuMsgPack.html
+++ b/cu29/cutask/trait.CuMsgPack.html
@@ -1,4 +1,4 @@
-CuMsgPack in cu29::cutask - Rust

Trait CuMsgPack

Source
pub trait CuMsgPack<'cl> { }

Implementations on Foreign Types§

Source§

impl CuMsgPack<'_> for ()

Source§

impl<'cl, T1, T2> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>)
where +CuMsgPack in cu29::cutask - Rust

Trait CuMsgPack

Source
pub trait CuMsgPack<'cl> { }

Implementations on Foreign Types§

Source§

impl CuMsgPack<'_> for ()

Source§

impl<'cl, T1, T2> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>)
where T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl,

Source§

impl<'cl, T1, T2, T3> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>, &'cl CuMsg<T3>)
where T1: CuMsgPayload + 'cl, diff --git a/cu29/cutask/trait.CuMsgPayload.html b/cu29/cutask/trait.CuMsgPayload.html index 76f8ad325..1d44a62a1 100644 --- a/cu29/cutask/trait.CuMsgPayload.html +++ b/cu29/cutask/trait.CuMsgPayload.html @@ -1,4 +1,4 @@ -CuMsgPayload in cu29::cutask - Rust

Trait CuMsgPayload

Source
pub trait CuMsgPayload:
+CuMsgPayload in cu29::cutask - Rust

Trait CuMsgPayload

Source
pub trait CuMsgPayload:
     Sized
     + Default
     + Debug
diff --git a/cu29/cutask/trait.CuSinkTask.html b/cu29/cutask/trait.CuSinkTask.html
index 7c01f6855..6428e2aed 100644
--- a/cu29/cutask/trait.CuSinkTask.html
+++ b/cu29/cutask/trait.CuSinkTask.html
@@ -1,4 +1,4 @@
-CuSinkTask in cu29::cutask - Rust

Trait CuSinkTask

Source
pub trait CuSinkTask<'cl>: Freezable {
+CuSinkTask in cu29::cutask - Rust

Trait CuSinkTask

Source
pub trait CuSinkTask<'cl>: Freezable {
     type Input: CuMsgPack<'cl>;
 
     // Required methods
diff --git a/cu29/cutask/trait.CuSrcTask.html b/cu29/cutask/trait.CuSrcTask.html
index 0c5caf6a0..871c315e8 100644
--- a/cu29/cutask/trait.CuSrcTask.html
+++ b/cu29/cutask/trait.CuSrcTask.html
@@ -1,4 +1,4 @@
-CuSrcTask in cu29::cutask - Rust

Trait CuSrcTask

Source
pub trait CuSrcTask<'cl>: Freezable {
+CuSrcTask in cu29::cutask - Rust

Trait CuSrcTask

Source
pub trait CuSrcTask<'cl>: Freezable {
     type Output: CuMsgPack<'cl>;
 
     // Required methods
diff --git a/cu29/cutask/trait.CuTask.html b/cu29/cutask/trait.CuTask.html
index ce2e791b3..3b450997d 100644
--- a/cu29/cutask/trait.CuTask.html
+++ b/cu29/cutask/trait.CuTask.html
@@ -1,4 +1,4 @@
-CuTask in cu29::cutask - Rust

Trait CuTask

Source
pub trait CuTask<'cl>: Freezable {
+CuTask in cu29::cutask - Rust

Trait CuTask

Source
pub trait CuTask<'cl>: Freezable {
     type Input: CuMsgPack<'cl>;
     type Output: CuMsgPack<'cl>;
 
diff --git a/cu29/cutask/trait.Freezable.html b/cu29/cutask/trait.Freezable.html
index 77d55a5be..627cb3088 100644
--- a/cu29/cutask/trait.Freezable.html
+++ b/cu29/cutask/trait.Freezable.html
@@ -1,4 +1,4 @@
-Freezable in cu29::cutask - Rust

Trait Freezable

Source
pub trait Freezable {
+Freezable in cu29::cutask - Rust

Trait Freezable

Source
pub trait Freezable {
     // Provided methods
     fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>
        where E: Encoder { ... }
diff --git a/cu29/enum.UnifiedLogType.html b/cu29/enum.UnifiedLogType.html
index 84314dd41..269c3c437 100644
--- a/cu29/enum.UnifiedLogType.html
+++ b/cu29/enum.UnifiedLogType.html
@@ -1,4 +1,4 @@
-UnifiedLogType in cu29 - Rust

Enum UnifiedLogType

pub enum UnifiedLogType {
+UnifiedLogType in cu29 - Rust

Enum UnifiedLogType

pub enum UnifiedLogType {
     Empty,
     StructuredLogLine,
     CopperList,
diff --git a/cu29/fn.read_configuration.html b/cu29/fn.read_configuration.html
index c8a8cf71c..6280d4679 100644
--- a/cu29/fn.read_configuration.html
+++ b/cu29/fn.read_configuration.html
@@ -1,2 +1,2 @@
-read_configuration in cu29 - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a file.

+read_configuration in cu29 - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a file.

\ No newline at end of file diff --git a/cu29/index.html b/cu29/index.html index 1fe942e23..34f88f8c5 100644 --- a/cu29/index.html +++ b/cu29/index.html @@ -1,4 +1,4 @@ -cu29 - Rust

Crate cu29

Source
Expand description
logo +cu29 - Rust

Crate cu29

Source
Expand description
logo

§

§Copper

copper GitHub last commit diff --git a/cu29/macro.input_msg.html b/cu29/macro.input_msg.html index c07ce832c..715f23a1d 100644 --- a/cu29/macro.input_msg.html +++ b/cu29/macro.input_msg.html @@ -1,4 +1,4 @@ -input_msg in cu29 - Rust

Macro input_msg

Source
macro_rules! input_msg {
+input_msg in cu29 - Rust

Macro input_msg

Source
macro_rules! input_msg {
     ($lifetime:lifetime, $ty:ty) => { ... };
     ($lifetime:lifetime, $($ty:ty),*) => { ... };
 }
\ No newline at end of file diff --git a/cu29/macro.output_msg.html b/cu29/macro.output_msg.html index 4fdee3357..78ea73d83 100644 --- a/cu29/macro.output_msg.html +++ b/cu29/macro.output_msg.html @@ -1,3 +1,3 @@ -output_msg in cu29 - Rust

Macro output_msg

Source
macro_rules! output_msg {
+output_msg in cu29 - Rust

Macro output_msg

Source
macro_rules! output_msg {
     ($lifetime:lifetime, $ty:ty) => { ... };
 }
\ No newline at end of file diff --git a/cu29/monitoring/enum.CuTaskState.html b/cu29/monitoring/enum.CuTaskState.html index 3c7845b5c..84f35b6cb 100644 --- a/cu29/monitoring/enum.CuTaskState.html +++ b/cu29/monitoring/enum.CuTaskState.html @@ -1,4 +1,4 @@ -CuTaskState in cu29::monitoring - Rust

Enum CuTaskState

Source
pub enum CuTaskState {
+CuTaskState in cu29::monitoring - Rust

Enum CuTaskState

Source
pub enum CuTaskState {
     Start,
     Preprocess,
     Process,
diff --git a/cu29/monitoring/enum.Decision.html b/cu29/monitoring/enum.Decision.html
index 1399484d8..383615d3b 100644
--- a/cu29/monitoring/enum.Decision.html
+++ b/cu29/monitoring/enum.Decision.html
@@ -1,4 +1,4 @@
-Decision in cu29::monitoring - Rust

Enum Decision

Source
pub enum Decision {
+Decision in cu29::monitoring - Rust

Enum Decision

Source
pub enum Decision {
     Abort,
     Ignore,
     Shutdown,
diff --git a/cu29/monitoring/index.html b/cu29/monitoring/index.html
index 37d83999a..b09e176cb 100644
--- a/cu29/monitoring/index.html
+++ b/cu29/monitoring/index.html
@@ -1,4 +1,4 @@
-cu29::monitoring - Rust

Module monitoring

Source
Expand description

Some basic internal monitoring tooling Copper uses to monitor itself and the tasks it is running.

+cu29::monitoring - Rust

Module monitoring

Source
Expand description

Some basic internal monitoring tooling Copper uses to monitor itself and the tasks it is running.

Structs§

CountingAllocator
A simple allocator that counts the number of bytes allocated and deallocated.
CuDurationStatistics
A Specialized statistics object for CuDuration. It will also keep track of the jitter between the values.
LiveStatistics
Accumulative stat object that can give your some real time statistics.
NoMonitor
A do nothing monitor if no monitor is provided. This is basically defining the default behavior of Copper in case of error.
ScopedAllocCounter
A simple struct that counts the number of bytes allocated and deallocated in a scope.

Enums§

CuTaskState
The state of a task.
Decision
Monitor decision to be taken when a task errored out.

Statics§

GLOBAL

Traits§

CuMonitor
Trait to implement a monitoring task.
\ No newline at end of file diff --git a/cu29/monitoring/static.GLOBAL.html b/cu29/monitoring/static.GLOBAL.html index f9c7d212c..46cb7c314 100644 --- a/cu29/monitoring/static.GLOBAL.html +++ b/cu29/monitoring/static.GLOBAL.html @@ -1 +1 @@ -GLOBAL in cu29::monitoring - Rust

Static GLOBAL

Source
pub static GLOBAL: CountingAllocator
\ No newline at end of file +GLOBAL in cu29::monitoring - Rust

Static GLOBAL

Source
pub static GLOBAL: CountingAllocator
\ No newline at end of file diff --git a/cu29/monitoring/struct.CountingAllocator.html b/cu29/monitoring/struct.CountingAllocator.html index d1597b9d3..a9c8ba9d6 100644 --- a/cu29/monitoring/struct.CountingAllocator.html +++ b/cu29/monitoring/struct.CountingAllocator.html @@ -1,4 +1,4 @@ -CountingAllocator in cu29::monitoring - Rust

Struct CountingAllocator

Source
pub struct CountingAllocator { /* private fields */ }
Expand description

A simple allocator that counts the number of bytes allocated and deallocated.

+CountingAllocator in cu29::monitoring - Rust

Struct CountingAllocator

Source
pub struct CountingAllocator { /* private fields */ }
Expand description

A simple allocator that counts the number of bytes allocated and deallocated.

Implementations§

Trait Implementations§

Source§

impl Default for CountingAllocator

Source§

fn default() -> CountingAllocator

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

impl GlobalAlloc for CountingAllocator

Source§

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocates memory as described by the given layout. Read more
Source§

unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout)

Deallocates the block of memory at the given ptr pointer with the given layout. Read more
1.28.0 · Source§

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

Behaves like alloc, but also ensures that the contents are set to zero before being returned. Read more
1.28.0 · Source§

unsafe fn realloc( &self, diff --git a/cu29/monitoring/struct.CuDurationStatistics.html b/cu29/monitoring/struct.CuDurationStatistics.html index d81afc7b2..df0d30a33 100644 --- a/cu29/monitoring/struct.CuDurationStatistics.html +++ b/cu29/monitoring/struct.CuDurationStatistics.html @@ -1,4 +1,4 @@ -CuDurationStatistics in cu29::monitoring - Rust

Struct CuDurationStatistics

Source
pub struct CuDurationStatistics { /* private fields */ }
Expand description

A Specialized statistics object for CuDuration. +CuDurationStatistics in cu29::monitoring - Rust

Struct CuDurationStatistics

Source
pub struct CuDurationStatistics { /* private fields */ }
Expand description

A Specialized statistics object for CuDuration. It will also keep track of the jitter between the values.

Implementations§

Source§

impl CuDurationStatistics

Source

pub fn new(max: CuDuration) -> CuDurationStatistics

Source

pub fn min(&self) -> CuDuration

Source

pub fn max(&self) -> CuDuration

Source

pub fn mean(&self) -> CuDuration

Source

pub fn percentile(&self, percentile: f64) -> CuDuration

Source

pub fn stddev(&self) -> CuDuration

Source

pub fn len(&self) -> u64

Source

pub fn is_empty(&self) -> bool

Source

pub fn jitter_min(&self) -> CuDuration

Source

pub fn jitter_max(&self) -> CuDuration

Source

pub fn jitter_mean(&self) -> CuDuration

Source

pub fn jitter_stddev(&self) -> CuDuration

Source

pub fn jitter_percentile(&self, percentile: f64) -> CuDuration

Source

pub fn record(&mut self, value: CuDuration)

Source

pub fn reset(&mut self)

Trait Implementations§

Source§

impl Clone for CuDurationStatistics

Source§

fn clone(&self) -> CuDurationStatistics

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 CuDurationStatistics

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29/monitoring/struct.LiveStatistics.html b/cu29/monitoring/struct.LiveStatistics.html index d193879e1..05cffd84a 100644 --- a/cu29/monitoring/struct.LiveStatistics.html +++ b/cu29/monitoring/struct.LiveStatistics.html @@ -1,4 +1,4 @@ -LiveStatistics in cu29::monitoring - Rust

Struct LiveStatistics

Source
pub struct LiveStatistics { /* private fields */ }
Expand description

Accumulative stat object that can give your some real time statistics.

+LiveStatistics in cu29::monitoring - Rust

Struct LiveStatistics

Source
pub struct LiveStatistics { /* private fields */ }
Expand description

Accumulative stat object that can give your some real time statistics.

Implementations§

Source§

impl LiveStatistics

Source

pub fn new_unbounded() -> LiveStatistics

Source

pub fn new_with_max(max: u64) -> LiveStatistics

Source

pub fn min(&self) -> u64

Source

pub fn max(&self) -> u64

Source

pub fn mean(&self) -> f64

Source

pub fn percentile(&self, percentile: f64) -> u64

Source

pub fn record(&mut self, value: u64)

Adds a value to the statistics.

Source

pub fn len(&self) -> u64

Source

pub fn is_empty(&self) -> bool

Source

pub fn reset(&mut self)

Trait Implementations§

Source§

impl Clone for LiveStatistics

Source§

fn clone(&self) -> LiveStatistics

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 LiveStatistics

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29/monitoring/struct.NoMonitor.html b/cu29/monitoring/struct.NoMonitor.html index a8ca253a1..0a7745ce7 100644 --- a/cu29/monitoring/struct.NoMonitor.html +++ b/cu29/monitoring/struct.NoMonitor.html @@ -1,4 +1,4 @@ -NoMonitor in cu29::monitoring - Rust

Struct NoMonitor

Source
pub struct NoMonitor {}
Expand description

A do nothing monitor if no monitor is provided. +NoMonitor in cu29::monitoring - Rust

Struct NoMonitor

Source
pub struct NoMonitor {}
Expand description

A do nothing monitor if no monitor is provided. This is basically defining the default behavior of Copper in case of error.

Trait Implementations§

Source§

impl CuMonitor for NoMonitor

Source§

fn new( _config: &CuConfig, diff --git a/cu29/monitoring/struct.ScopedAllocCounter.html b/cu29/monitoring/struct.ScopedAllocCounter.html index be5e29d03..d872e3c4b 100644 --- a/cu29/monitoring/struct.ScopedAllocCounter.html +++ b/cu29/monitoring/struct.ScopedAllocCounter.html @@ -1,4 +1,4 @@ -ScopedAllocCounter in cu29::monitoring - Rust

Struct ScopedAllocCounter

Source
pub struct ScopedAllocCounter { /* private fields */ }
Expand description

A simple struct that counts the number of bytes allocated and deallocated in a scope.

+ScopedAllocCounter in cu29::monitoring - Rust

Struct ScopedAllocCounter

Source
pub struct ScopedAllocCounter { /* private fields */ }
Expand description

A simple struct that counts the number of bytes allocated and deallocated in a scope.

Implementations§

Source§

impl ScopedAllocCounter

Source

pub fn new() -> ScopedAllocCounter

Source

pub fn get_allocated(&self) -> usize

Returns the total number of bytes allocated in the current scope since the creation of this ScopedAllocCounter.

§Example
diff --git a/cu29/monitoring/trait.CuMonitor.html b/cu29/monitoring/trait.CuMonitor.html index 606f62c12..ffb5cc433 100644 --- a/cu29/monitoring/trait.CuMonitor.html +++ b/cu29/monitoring/trait.CuMonitor.html @@ -1,4 +1,4 @@ -CuMonitor in cu29::monitoring - Rust

Trait CuMonitor

Source
pub trait CuMonitor: Sized {
+CuMonitor in cu29::monitoring - Rust

Trait CuMonitor

Source
pub trait CuMonitor: Sized {
     // Required methods
     fn new(
         config: &CuConfig,
diff --git a/cu29/payload/index.html b/cu29/payload/index.html
index 9268e5444..d30ca1db6 100644
--- a/cu29/payload/index.html
+++ b/cu29/payload/index.html
@@ -1 +1 @@
-cu29::payload - Rust

Module payload

Source

Structs§

CuArray
Copper friendly wrapper for a fixed size array.
\ No newline at end of file +cu29::payload - Rust

Module payload

Source

Structs§

CuArray
Copper friendly wrapper for a fixed size array.
\ No newline at end of file diff --git a/cu29/payload/struct.CuArray.html b/cu29/payload/struct.CuArray.html index a29db71b3..cbef66b75 100644 --- a/cu29/payload/struct.CuArray.html +++ b/cu29/payload/struct.CuArray.html @@ -1,4 +1,4 @@ -CuArray in cu29::payload - Rust

Struct CuArray

Source
pub struct CuArray<T, const N: usize> { /* private fields */ }
Expand description

Copper friendly wrapper for a fixed size array.

+CuArray in cu29::payload - Rust

Struct CuArray

Source
pub struct CuArray<T, const N: usize> { /* private fields */ }
Expand description

Copper friendly wrapper for a fixed size array.

Implementations§

Source§

impl<T, const N: usize> CuArray<T, N>

Source

pub fn new() -> CuArray<T, N>

Source

pub fn fill_from_iter<I>(&mut self, iter: I)
where I: IntoIterator<Item = T>,

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn as_slice(&self) -> &[T]

Source

pub fn capacity(&self) -> usize

Trait Implementations§

Source§

impl<T, const N: usize> Clone for CuArray<T, N>
where T: Clone,

Source§

fn clone(&self) -> CuArray<T, N>

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<T, const N: usize> Debug for CuArray<T, N>
where diff --git a/cu29/prelude/attr.copper_runtime.html b/cu29/prelude/attr.copper_runtime.html index 24089754e..0d96e491b 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

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. +copper_runtime in cu29::prelude - Rust

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/fn.read_configuration.html b/cu29/prelude/config/fn.read_configuration.html index c81953a0f..acd0eb11f 100644 --- a/cu29/prelude/config/fn.read_configuration.html +++ b/cu29/prelude/config/fn.read_configuration.html @@ -1,2 +1,2 @@ -read_configuration in cu29::prelude::config - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a file.

+read_configuration in cu29::prelude::config - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a file.

\ No newline at end of file diff --git a/cu29/prelude/config/fn.read_configuration_str.html b/cu29/prelude/config/fn.read_configuration_str.html index abfef75da..06b401eb1 100644 --- a/cu29/prelude/config/fn.read_configuration_str.html +++ b/cu29/prelude/config/fn.read_configuration_str.html @@ -1,4 +1,4 @@ -read_configuration_str in cu29::prelude::config - Rust

Function read_configuration_str

Source
pub fn read_configuration_str(
+read_configuration_str in cu29::prelude::config - Rust

Function read_configuration_str

Source
pub fn read_configuration_str(
     config_content: String,
 ) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a String.

\ No newline at end of file diff --git a/cu29/prelude/config/index.html b/cu29/prelude/config/index.html index e6c4a3c59..e091bdc48 100644 --- a/cu29/prelude/config/index.html +++ b/cu29/prelude/config/index.html @@ -1,4 +1,4 @@ -cu29::prelude::config - Rust

Module config

Source
Expand description

This module defines the configuration of the copper runtime. +cu29::prelude::config - Rust

Module config

Source
Expand description

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

diff --git a/cu29/prelude/config/struct.Cnx.html b/cu29/prelude/config/struct.Cnx.html index 272527d17..07af51297 100644 --- a/cu29/prelude/config/struct.Cnx.html +++ b/cu29/prelude/config/struct.Cnx.html @@ -1,4 +1,4 @@ -Cnx in cu29::prelude::config - Rust

Struct Cnx

Source
pub struct Cnx {
+Cnx in cu29::prelude::config - Rust

Struct Cnx

Source
pub struct Cnx {
     pub msg: String,
     pub batch: Option<u32>,
     pub store: Option<bool>,
diff --git a/cu29/prelude/config/struct.ComponentConfig.html b/cu29/prelude/config/struct.ComponentConfig.html
index 5fc19106a..65f4f72bf 100644
--- a/cu29/prelude/config/struct.ComponentConfig.html
+++ b/cu29/prelude/config/struct.ComponentConfig.html
@@ -1,4 +1,4 @@
-ComponentConfig in cu29::prelude::config - Rust

Struct ComponentConfig

Source
pub struct ComponentConfig(pub HashMap<String, Value>);
Expand description

This is the configuration of a component (like a task config or a monitoring config):w +ComponentConfig in cu29::prelude::config - Rust

Struct ComponentConfig

Source
pub struct ComponentConfig(pub HashMap<String, Value>);
Expand description

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

Tuple Fields§

§0: HashMap<String, Value>

Implementations§

Source§

impl ComponentConfig

Source

pub fn new() -> ComponentConfig

Source

pub fn get<T>(&self, key: &str) -> Option<T>
where diff --git a/cu29/prelude/config/struct.CuConfig.html b/cu29/prelude/config/struct.CuConfig.html index 3f219c234..16fa37f62 100644 --- a/cu29/prelude/config/struct.CuConfig.html +++ b/cu29/prelude/config/struct.CuConfig.html @@ -1,4 +1,4 @@ -CuConfig in cu29::prelude::config - Rust

Struct CuConfig

Source
pub struct CuConfig {
+CuConfig in cu29::prelude::config - Rust

Struct CuConfig

Source
pub struct CuConfig {
     pub graph: StableGraph<Node, Cnx>,
     pub monitor: Option<MonitorConfig>,
     pub logging: Option<LoggingConfig>,
diff --git a/cu29/prelude/config/struct.LoggingConfig.html b/cu29/prelude/config/struct.LoggingConfig.html
index d07bfe708..6bd9da0b3 100644
--- a/cu29/prelude/config/struct.LoggingConfig.html
+++ b/cu29/prelude/config/struct.LoggingConfig.html
@@ -1,4 +1,4 @@
-LoggingConfig in cu29::prelude::config - Rust

Struct LoggingConfig

Source
pub struct LoggingConfig {
+LoggingConfig in cu29::prelude::config - Rust

Struct LoggingConfig

Source
pub struct LoggingConfig {
     pub slab_size_mib: Option<u64>,
     pub section_size_mib: Option<u64>,
     pub enable_task_logging: bool,
diff --git a/cu29/prelude/config/struct.MonitorConfig.html b/cu29/prelude/config/struct.MonitorConfig.html
index 76cfaecf0..eb671b70a 100644
--- a/cu29/prelude/config/struct.MonitorConfig.html
+++ b/cu29/prelude/config/struct.MonitorConfig.html
@@ -1,4 +1,4 @@
-MonitorConfig in cu29::prelude::config - Rust

Struct MonitorConfig

Source
pub struct MonitorConfig { /* private fields */ }

Implementations§

Trait Implementations§

Source§

impl Clone for MonitorConfig

Source§

fn clone(&self) -> MonitorConfig

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 MonitorConfig

Source§

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

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

impl Default for MonitorConfig

Source§

fn default() -> MonitorConfig

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

impl<'de> Deserialize<'de> for MonitorConfig

Source§

fn deserialize<__D>( +MonitorConfig in cu29::prelude::config - Rust

Struct MonitorConfig

Source
pub struct MonitorConfig { /* private fields */ }

Implementations§

Trait Implementations§

Source§

impl Clone for MonitorConfig

Source§

fn clone(&self) -> MonitorConfig

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 MonitorConfig

Source§

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

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

impl Default for MonitorConfig

Source§

fn default() -> MonitorConfig

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

impl<'de> Deserialize<'de> for MonitorConfig

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<MonitorConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MonitorConfig

Source§

fn serialize<__S>( diff --git a/cu29/prelude/config/struct.Node.html b/cu29/prelude/config/struct.Node.html index 4c2fb0a81..6733324fc 100644 --- a/cu29/prelude/config/struct.Node.html +++ b/cu29/prelude/config/struct.Node.html @@ -1,4 +1,4 @@ -Node in cu29::prelude::config - Rust

Struct Node

Source
pub struct Node { /* private fields */ }
Expand description

A node in the configuration graph. +Node in cu29::prelude::config - Rust

Struct Node

Source
pub struct Node { /* private fields */ }
Expand description

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

Implementations§

Source§

impl Node

Source

pub fn new(id: &str, ptype: &str) -> Node

Source

pub fn get_id(&self) -> String

Source

pub fn set_type(self, name: Option<String>) -> Node

Source

pub fn get_type(&self) -> &str

Source

pub fn get_instance_config(&self) -> Option<&ComponentConfig>

Source

pub fn get_param<T>(&self, key: &str) -> Option<T>
where T: From<Value>,

Source

pub fn set_param<T>(&mut self, key: &str, value: T)
where diff --git a/cu29/prelude/config/struct.Value.html b/cu29/prelude/config/struct.Value.html index e76dae928..6948710f2 100644 --- a/cu29/prelude/config/struct.Value.html +++ b/cu29/prelude/config/struct.Value.html @@ -1,4 +1,4 @@ -Value in cu29::prelude::config - Rust

Struct Value

Source
pub struct Value(/* private fields */);
Expand description

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

+Value in cu29::prelude::config - Rust

Struct Value

Source
pub struct Value(/* private fields */);
Expand description

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

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

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 Value

Source§

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

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

impl<'de> Deserialize<'de> for Value

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Value, <__D as Deserializer<'de>>::Error>
where diff --git a/cu29/prelude/config/type.NodeId.html b/cu29/prelude/config/type.NodeId.html index 040f14474..97aa5d9c6 100644 --- a/cu29/prelude/config/type.NodeId.html +++ b/cu29/prelude/config/type.NodeId.html @@ -1,3 +1,3 @@ -NodeId in cu29::prelude::config - Rust

Type Alias NodeId

Source
pub type NodeId = u32;
Expand description

NodeId is the unique identifier of a node in the configuration graph for petgraph +NodeId in cu29::prelude::config - Rust

Type Alias NodeId

Source
pub type NodeId = u32;
Expand description

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

\ No newline at end of file diff --git a/cu29/prelude/constant.ANONYMOUS.html b/cu29/prelude/constant.ANONYMOUS.html index 26bf79527..edaca14ea 100644 --- a/cu29/prelude/constant.ANONYMOUS.html +++ b/cu29/prelude/constant.ANONYMOUS.html @@ -1 +1 @@ -ANONYMOUS in cu29::prelude - Rust

Constant ANONYMOUS

pub const ANONYMOUS: u32 = 0; // 0u32
\ No newline at end of file +ANONYMOUS in cu29::prelude - Rust

Constant ANONYMOUS

pub const ANONYMOUS: u32 = 0; // 0u32
\ No newline at end of file diff --git a/cu29/prelude/constant.MAX_LOG_PARAMS_ON_STACK.html b/cu29/prelude/constant.MAX_LOG_PARAMS_ON_STACK.html index 75bde68d4..2a86ee885 100644 --- a/cu29/prelude/constant.MAX_LOG_PARAMS_ON_STACK.html +++ b/cu29/prelude/constant.MAX_LOG_PARAMS_ON_STACK.html @@ -1 +1 @@ -MAX_LOG_PARAMS_ON_STACK in cu29::prelude - Rust

Constant MAX_LOG_PARAMS_ON_STACK

pub const MAX_LOG_PARAMS_ON_STACK: usize = 10; // 10usize
\ No newline at end of file +MAX_LOG_PARAMS_ON_STACK in cu29::prelude - Rust

Constant MAX_LOG_PARAMS_ON_STACK

pub const MAX_LOG_PARAMS_ON_STACK: usize = 10; // 10usize
\ No newline at end of file diff --git a/cu29/prelude/copperlist/enum.CopperListState.html b/cu29/prelude/copperlist/enum.CopperListState.html index 4b4e9eb3a..213952aaa 100644 --- a/cu29/prelude/copperlist/enum.CopperListState.html +++ b/cu29/prelude/copperlist/enum.CopperListState.html @@ -1,4 +1,4 @@ -CopperListState in cu29::prelude::copperlist - Rust

Enum CopperListState

Source
pub enum CopperListState {
+CopperListState in cu29::prelude::copperlist - Rust

Enum CopperListState

Source
pub enum CopperListState {
     Free,
     Initialized,
     Processing,
diff --git a/cu29/prelude/copperlist/index.html b/cu29/prelude/copperlist/index.html
index 013dd17d3..b644044fd 100644
--- a/cu29/prelude/copperlist/index.html
+++ b/cu29/prelude/copperlist/index.html
@@ -1,4 +1,4 @@
-cu29::prelude::copperlist - Rust

Module copperlist

Source
Expand description

CopperList is the main data structure used by Copper to communicate between tasks. +cu29::prelude::copperlist - Rust

Module copperlist

Source
Expand description

CopperList is the main data structure used by Copper to communicate between tasks. It is a queue that can be used to store preallocated messages between tasks in memory order.

Structs§

CopperLiskMask
Not implemented yet. This mask will be used to for example filter out necessary regions of a copper list between remote systems.
CopperList
CuListsManager
This structure maintains the entire memory needed by Copper for one loop for the inter tasks communication within a process. diff --git a/cu29/prelude/copperlist/struct.CopperLiskMask.html b/cu29/prelude/copperlist/struct.CopperLiskMask.html index fb17b6a1c..a20aedbef 100644 --- a/cu29/prelude/copperlist/struct.CopperLiskMask.html +++ b/cu29/prelude/copperlist/struct.CopperLiskMask.html @@ -1,4 +1,4 @@ -CopperLiskMask in cu29::prelude::copperlist - Rust

Struct CopperLiskMask

Source
pub struct CopperLiskMask { /* private fields */ }
Expand description

Not implemented yet. +CopperLiskMask in cu29::prelude::copperlist - Rust

Struct CopperLiskMask

Source
pub struct CopperLiskMask { /* private fields */ }
Expand description

Not implemented yet. This mask will be used to for example filter out necessary regions of a copper list between remote systems.

Trait Implementations§

Source§

impl<'__de> BorrowDecode<'__de> for CopperLiskMask

Source§

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

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

impl Clone for CopperLiskMask

Source§

fn clone(&self) -> CopperLiskMask

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 CopperLiskMask

Source§

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

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

impl Decode for CopperLiskMask

Source§

fn decode<__D>(decoder: &mut __D) -> Result<CopperLiskMask, DecodeError>
where diff --git a/cu29/prelude/copperlist/struct.CopperList.html b/cu29/prelude/copperlist/struct.CopperList.html index 208fab988..0939a1c69 100644 --- a/cu29/prelude/copperlist/struct.CopperList.html +++ b/cu29/prelude/copperlist/struct.CopperList.html @@ -1,4 +1,4 @@ -CopperList in cu29::prelude::copperlist - Rust

Struct CopperList

Source
pub struct CopperList<P>
where +CopperList in cu29::prelude::copperlist - Rust

Struct CopperList

Source
pub struct CopperList<P>
where P: CopperListTuple,
{ pub id: u32, pub msgs: P, diff --git a/cu29/prelude/copperlist/struct.CuListsManager.html b/cu29/prelude/copperlist/struct.CuListsManager.html index 4c6bf6a7d..770854d69 100644 --- a/cu29/prelude/copperlist/struct.CuListsManager.html +++ b/cu29/prelude/copperlist/struct.CuListsManager.html @@ -1,4 +1,4 @@ -CuListsManager in cu29::prelude::copperlist - Rust

Struct CuListsManager

Source
pub struct CuListsManager<P, const N: usize>
where +CuListsManager in cu29::prelude::copperlist - Rust

Struct CuListsManager

Source
pub struct CuListsManager<P, const N: usize>
where P: CopperListTuple,
{ /* private fields */ }
Expand description

This structure maintains the entire memory needed by Copper for one loop for the inter tasks communication within a process. P or Payload is typically a Tuple of various types of messages that are exchanged between tasks. N is the maximum number of in flight Copper List the runtime can support.

diff --git a/cu29/prelude/copperlist/type.AscIter.html b/cu29/prelude/copperlist/type.AscIter.html index 02bfa8581..56b560446 100644 --- a/cu29/prelude/copperlist/type.AscIter.html +++ b/cu29/prelude/copperlist/type.AscIter.html @@ -1 +1 @@ -AscIter in cu29::prelude::copperlist - Rust

Type Alias AscIter

Source
pub type AscIter<'a, T> = Chain<Iter<'a, T>, Iter<'a, T>>;

Aliased Type§

struct AscIter<'a, T> { /* private fields */ }
\ No newline at end of file +AscIter in cu29::prelude::copperlist - Rust

Type Alias AscIter

Source
pub type AscIter<'a, T> = Chain<Iter<'a, T>, Iter<'a, T>>;

Aliased Type§

struct AscIter<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/prelude/copperlist/type.AscIterMut.html b/cu29/prelude/copperlist/type.AscIterMut.html index 2ecb2f9fa..5285e7b21 100644 --- a/cu29/prelude/copperlist/type.AscIterMut.html +++ b/cu29/prelude/copperlist/type.AscIterMut.html @@ -1 +1 @@ -AscIterMut in cu29::prelude::copperlist - Rust

Type Alias AscIterMut

Source
pub type AscIterMut<'a, T> = Chain<IterMut<'a, T>, IterMut<'a, T>>;

Aliased Type§

struct AscIterMut<'a, T> { /* private fields */ }
\ No newline at end of file +AscIterMut in cu29::prelude::copperlist - Rust

Type Alias AscIterMut

Source
pub type AscIterMut<'a, T> = Chain<IterMut<'a, T>, IterMut<'a, T>>;

Aliased Type§

struct AscIterMut<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/prelude/copperlist/type.Iter.html b/cu29/prelude/copperlist/type.Iter.html index c86aec6b2..1c8c88395 100644 --- a/cu29/prelude/copperlist/type.Iter.html +++ b/cu29/prelude/copperlist/type.Iter.html @@ -1 +1 @@ -Iter in cu29::prelude::copperlist - Rust

Type Alias Iter

Source
pub type Iter<'a, T> = Chain<Rev<Iter<'a, T>>, Rev<Iter<'a, T>>>;

Aliased Type§

struct Iter<'a, T> { /* private fields */ }
\ No newline at end of file +Iter in cu29::prelude::copperlist - Rust

Type Alias Iter

Source
pub type Iter<'a, T> = Chain<Rev<Iter<'a, T>>, Rev<Iter<'a, T>>>;

Aliased Type§

struct Iter<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/prelude/copperlist/type.IterMut.html b/cu29/prelude/copperlist/type.IterMut.html index 270487ae9..5b393aaf3 100644 --- a/cu29/prelude/copperlist/type.IterMut.html +++ b/cu29/prelude/copperlist/type.IterMut.html @@ -1 +1 @@ -IterMut in cu29::prelude::copperlist - Rust

Type Alias IterMut

Source
pub type IterMut<'a, T> = Chain<Rev<IterMut<'a, T>>, Rev<IterMut<'a, T>>>;

Aliased Type§

struct IterMut<'a, T> { /* private fields */ }
\ No newline at end of file +IterMut in cu29::prelude::copperlist - Rust

Type Alias IterMut

Source
pub type IterMut<'a, T> = Chain<Rev<IterMut<'a, T>>, Rev<IterMut<'a, T>>>;

Aliased Type§

struct IterMut<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/prelude/curuntime/enum.CuExecutionUnit.html b/cu29/prelude/curuntime/enum.CuExecutionUnit.html index 4fe53d723..75a402fea 100644 --- a/cu29/prelude/curuntime/enum.CuExecutionUnit.html +++ b/cu29/prelude/curuntime/enum.CuExecutionUnit.html @@ -1,4 +1,4 @@ -CuExecutionUnit in cu29::prelude::curuntime - Rust

Enum CuExecutionUnit

Source
pub enum CuExecutionUnit {
+CuExecutionUnit in cu29::prelude::curuntime - Rust

Enum CuExecutionUnit

Source
pub enum CuExecutionUnit {
     Step(CuExecutionStep),
     Loop(CuExecutionLoop),
 }
Expand description

This structure represents a step in the execution plan.

diff --git a/cu29/prelude/curuntime/enum.CuTaskType.html b/cu29/prelude/curuntime/enum.CuTaskType.html index c0a83cbe0..82ebc1cac 100644 --- a/cu29/prelude/curuntime/enum.CuTaskType.html +++ b/cu29/prelude/curuntime/enum.CuTaskType.html @@ -1,4 +1,4 @@ -CuTaskType in cu29::prelude::curuntime - Rust

Enum CuTaskType

Source
pub enum CuTaskType {
+CuTaskType in cu29::prelude::curuntime - Rust

Enum CuTaskType

Source
pub enum CuTaskType {
     Source,
     Regular,
     Sink,
diff --git a/cu29/prelude/curuntime/fn.compute_runtime_plan.html b/cu29/prelude/curuntime/fn.compute_runtime_plan.html
index 9b7c7a860..17e68e67e 100644
--- a/cu29/prelude/curuntime/fn.compute_runtime_plan.html
+++ b/cu29/prelude/curuntime/fn.compute_runtime_plan.html
@@ -1,4 +1,4 @@
-compute_runtime_plan in cu29::prelude::curuntime - Rust

Function compute_runtime_plan

Source
pub fn compute_runtime_plan(
+compute_runtime_plan in cu29::prelude::curuntime - Rust

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 pluggable.

diff --git a/cu29/prelude/curuntime/fn.find_task_type_for_id.html b/cu29/prelude/curuntime/fn.find_task_type_for_id.html index 9a3d91217..3d23bfae8 100644 --- a/cu29/prelude/curuntime/fn.find_task_type_for_id.html +++ b/cu29/prelude/curuntime/fn.find_task_type_for_id.html @@ -1,4 +1,4 @@ -find_task_type_for_id in cu29::prelude::curuntime - Rust

Function find_task_type_for_id

Source
pub fn find_task_type_for_id(
+find_task_type_for_id in cu29::prelude::curuntime - Rust

Function find_task_type_for_id

Source
pub fn find_task_type_for_id(
     graph: &StableGraph<Node, Cnx>,
     node_id: u32,
 ) -> CuTaskType
\ No newline at end of file diff --git a/cu29/prelude/curuntime/index.html b/cu29/prelude/curuntime/index.html index 023e4292a..72504de63 100644 --- a/cu29/prelude/curuntime/index.html +++ b/cu29/prelude/curuntime/index.html @@ -1,4 +1,4 @@ -cu29::prelude::curuntime - Rust

Module curuntime

Source
Expand description

CuRuntime is the heart of what copper is running on the robot. +cu29::prelude::curuntime - Rust

Module curuntime

Source
Expand description

CuRuntime is the heart of what copper is running on the robot. It is exposed to the user via the copper_runtime macro injecting it as a field in their application struct.

Structs§

CopperContext
Just a simple struct to hold the various bits needed to run a Copper application.
CuExecutionLoop
This structure represents a loop in the execution plan. It is used to represent a sequence of Execution units (loop or steps) that are executed diff --git a/cu29/prelude/curuntime/struct.CopperContext.html b/cu29/prelude/curuntime/struct.CopperContext.html index 57e7bfd99..864ac3712 100644 --- a/cu29/prelude/curuntime/struct.CopperContext.html +++ b/cu29/prelude/curuntime/struct.CopperContext.html @@ -1,4 +1,4 @@ -CopperContext in cu29::prelude::curuntime - Rust

Struct CopperContext

Source
pub struct CopperContext {
+CopperContext in cu29::prelude::curuntime - Rust

Struct CopperContext

Source
pub struct CopperContext {
     pub unified_logger: Arc<Mutex<UnifiedLoggerWrite>>,
     pub logger_runtime: LoggerRuntime,
     pub clock: RobotClock,
diff --git a/cu29/prelude/curuntime/struct.CuExecutionLoop.html b/cu29/prelude/curuntime/struct.CuExecutionLoop.html
index a53a6b8d4..85ea4cf2a 100644
--- a/cu29/prelude/curuntime/struct.CuExecutionLoop.html
+++ b/cu29/prelude/curuntime/struct.CuExecutionLoop.html
@@ -1,4 +1,4 @@
-CuExecutionLoop in cu29::prelude::curuntime - Rust

Struct CuExecutionLoop

Source
pub struct CuExecutionLoop {
+CuExecutionLoop in cu29::prelude::curuntime - Rust

Struct CuExecutionLoop

Source
pub struct CuExecutionLoop {
     pub steps: Vec<CuExecutionUnit>,
     pub loop_count: Option<u32>,
 }
Expand description

This structure represents a loop in the execution plan. diff --git a/cu29/prelude/curuntime/struct.CuExecutionStep.html b/cu29/prelude/curuntime/struct.CuExecutionStep.html index 0021bbb28..3d3902c5c 100644 --- a/cu29/prelude/curuntime/struct.CuExecutionStep.html +++ b/cu29/prelude/curuntime/struct.CuExecutionStep.html @@ -1,4 +1,4 @@ -CuExecutionStep in cu29::prelude::curuntime - Rust

Struct CuExecutionStep

Source
pub struct CuExecutionStep {
+CuExecutionStep in cu29::prelude::curuntime - Rust

Struct CuExecutionStep

Source
pub struct CuExecutionStep {
     pub node_id: u32,
     pub node: Node,
     pub task_type: CuTaskType,
diff --git a/cu29/prelude/curuntime/struct.CuRuntime.html b/cu29/prelude/curuntime/struct.CuRuntime.html
index e6e8ec128..7ac7f16e4 100644
--- a/cu29/prelude/curuntime/struct.CuRuntime.html
+++ b/cu29/prelude/curuntime/struct.CuRuntime.html
@@ -1,4 +1,4 @@
-CuRuntime in cu29::prelude::curuntime - Rust

Struct CuRuntime

Source
pub struct CuRuntime<CT, P, M, const NBCL: usize>
where +CuRuntime in cu29::prelude::curuntime - Rust

Struct CuRuntime

Source
pub struct CuRuntime<CT, P, M, const NBCL: usize>{
     pub tasks: CT,
diff --git a/cu29/prelude/cutask/index.html b/cu29/prelude/cutask/index.html
index 7da8aa22c..f3bf62dac 100644
--- a/cu29/prelude/cutask/index.html
+++ b/cu29/prelude/cutask/index.html
@@ -1,4 +1,4 @@
-cu29::prelude::cutask - Rust

Module cutask

Source
Expand description

This module contains all the main definition of the traits you need to implement +cu29::prelude::cutask - Rust

Module cutask

Source
Expand description

This module contains all the main definition of the traits you need to implement or interact with to create a Copper task.

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. diff --git a/cu29/prelude/cutask/struct.CuCompactString.html b/cu29/prelude/cutask/struct.CuCompactString.html index 78c15c852..496788941 100644 --- a/cu29/prelude/cutask/struct.CuCompactString.html +++ b/cu29/prelude/cutask/struct.CuCompactString.html @@ -1,4 +1,4 @@ -CuCompactString in cu29::prelude::cutask - Rust

Struct CuCompactString

Source
pub struct CuCompactString(pub CompactString);

Tuple Fields§

§0: CompactString

Trait Implementations§

Source§

impl<'de> BorrowDecode<'de> for CuCompactString

Source§

fn borrow_decode<D>(decoder: &mut D) -> Result<CuCompactString, DecodeError>
where +CuCompactString in cu29::prelude::cutask - Rust

Struct CuCompactString

Source
pub struct CuCompactString(pub CompactString);

Tuple Fields§

§0: CompactString

Trait Implementations§

Source§

impl<'de> BorrowDecode<'de> for CuCompactString

Source§

fn borrow_decode<D>(decoder: &mut D) -> Result<CuCompactString, DecodeError>
where D: BorrowDecoder<'de>,

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

impl Clone for CuCompactString

Source§

fn clone(&self) -> CuCompactString

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 CuCompactString

Source§

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

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

impl Decode for CuCompactString

Source§

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

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

impl Default for CuCompactString

Source§

fn default() -> CuCompactString

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

impl<'de> Deserialize<'de> for CuCompactString

Source§

fn deserialize<__D>( __deserializer: __D, diff --git a/cu29/prelude/cutask/struct.CuMsg.html b/cu29/prelude/cutask/struct.CuMsg.html index 2dd9a01d4..a166de358 100644 --- a/cu29/prelude/cutask/struct.CuMsg.html +++ b/cu29/prelude/cutask/struct.CuMsg.html @@ -1,4 +1,4 @@ -CuMsg in cu29::prelude::cutask - Rust

Struct CuMsg

Source
pub struct CuMsg<T>
where +CuMsg in cu29::prelude::cutask - Rust

Struct CuMsg

Source
pub struct CuMsg<T>
where T: CuMsgPayload,
{ pub metadata: CuMsgMetadata, /* private fields */ diff --git a/cu29/prelude/cutask/struct.CuMsgMetadata.html b/cu29/prelude/cutask/struct.CuMsgMetadata.html index b26db5284..4997a3b0d 100644 --- a/cu29/prelude/cutask/struct.CuMsgMetadata.html +++ b/cu29/prelude/cutask/struct.CuMsgMetadata.html @@ -1,4 +1,4 @@ -CuMsgMetadata in cu29::prelude::cutask - Rust

Struct CuMsgMetadata

Source
pub struct CuMsgMetadata {
+CuMsgMetadata in cu29::prelude::cutask - Rust

Struct CuMsgMetadata

Source
pub struct CuMsgMetadata {
     pub process_time: PartialCuTimeRange,
     pub tov: Tov,
     pub status_txt: CuCompactString,
diff --git a/cu29/prelude/cutask/trait.CuMsgPack.html b/cu29/prelude/cutask/trait.CuMsgPack.html
index 5b002916f..88177e86b 100644
--- a/cu29/prelude/cutask/trait.CuMsgPack.html
+++ b/cu29/prelude/cutask/trait.CuMsgPack.html
@@ -1,4 +1,4 @@
-CuMsgPack in cu29::prelude::cutask - Rust

Trait CuMsgPack

Source
pub trait CuMsgPack<'cl> { }

Implementations on Foreign Types§

Source§

impl CuMsgPack<'_> for ()

Source§

impl<'cl, T1, T2> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>)
where +CuMsgPack in cu29::prelude::cutask - Rust

Trait CuMsgPack

Source
pub trait CuMsgPack<'cl> { }

Implementations on Foreign Types§

Source§

impl CuMsgPack<'_> for ()

Source§

impl<'cl, T1, T2> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>)
where T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl,

Source§

impl<'cl, T1, T2, T3> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>, &'cl CuMsg<T3>)
where T1: CuMsgPayload + 'cl, diff --git a/cu29/prelude/cutask/trait.CuMsgPayload.html b/cu29/prelude/cutask/trait.CuMsgPayload.html index bef13276b..a3c98a542 100644 --- a/cu29/prelude/cutask/trait.CuMsgPayload.html +++ b/cu29/prelude/cutask/trait.CuMsgPayload.html @@ -1,4 +1,4 @@ -CuMsgPayload in cu29::prelude::cutask - Rust

Trait CuMsgPayload

Source
pub trait CuMsgPayload:
+CuMsgPayload in cu29::prelude::cutask - Rust

Trait CuMsgPayload

Source
pub trait CuMsgPayload:
     Sized
     + Default
     + Debug
diff --git a/cu29/prelude/cutask/trait.CuSinkTask.html b/cu29/prelude/cutask/trait.CuSinkTask.html
index be1c39b05..f08c28bdd 100644
--- a/cu29/prelude/cutask/trait.CuSinkTask.html
+++ b/cu29/prelude/cutask/trait.CuSinkTask.html
@@ -1,4 +1,4 @@
-CuSinkTask in cu29::prelude::cutask - Rust

Trait CuSinkTask

Source
pub trait CuSinkTask<'cl>: Freezable {
+CuSinkTask in cu29::prelude::cutask - Rust

Trait CuSinkTask

Source
pub trait CuSinkTask<'cl>: Freezable {
     type Input: CuMsgPack<'cl>;
 
     // Required methods
diff --git a/cu29/prelude/cutask/trait.CuSrcTask.html b/cu29/prelude/cutask/trait.CuSrcTask.html
index eebfe5b4f..47250bb28 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

Trait CuSrcTask

Source
pub trait CuSrcTask<'cl>: Freezable {
+CuSrcTask in cu29::prelude::cutask - Rust

Trait CuSrcTask

Source
pub trait CuSrcTask<'cl>: Freezable {
     type Output: CuMsgPack<'cl>;
 
     // Required methods
diff --git a/cu29/prelude/cutask/trait.CuTask.html b/cu29/prelude/cutask/trait.CuTask.html
index 1c625e777..cb278cd54 100644
--- a/cu29/prelude/cutask/trait.CuTask.html
+++ b/cu29/prelude/cutask/trait.CuTask.html
@@ -1,4 +1,4 @@
-CuTask in cu29::prelude::cutask - Rust

Trait CuTask

Source
pub trait CuTask<'cl>: Freezable {
+CuTask in cu29::prelude::cutask - Rust

Trait CuTask

Source
pub trait CuTask<'cl>: Freezable {
     type Input: CuMsgPack<'cl>;
     type Output: CuMsgPack<'cl>;
 
diff --git a/cu29/prelude/cutask/trait.Freezable.html b/cu29/prelude/cutask/trait.Freezable.html
index b3e93187d..19c172305 100644
--- a/cu29/prelude/cutask/trait.Freezable.html
+++ b/cu29/prelude/cutask/trait.Freezable.html
@@ -1,4 +1,4 @@
-Freezable in cu29::prelude::cutask - Rust

Trait Freezable

Source
pub trait Freezable {
+Freezable in cu29::prelude::cutask - Rust

Trait Freezable

Source
pub trait Freezable {
     // Provided methods
     fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>
        where E: Encoder { ... }
diff --git a/cu29/prelude/enum.AllocatedSection.html b/cu29/prelude/enum.AllocatedSection.html
index 06d6f4d41..d0594f829 100644
--- a/cu29/prelude/enum.AllocatedSection.html
+++ b/cu29/prelude/enum.AllocatedSection.html
@@ -1,4 +1,4 @@
-AllocatedSection in cu29::prelude - Rust

Enum AllocatedSection

pub enum AllocatedSection {
+AllocatedSection in cu29::prelude - Rust

Enum AllocatedSection

pub enum AllocatedSection {
     NoMoreSpace,
     Section(SectionHandle),
 }

Variants§

§

NoMoreSpace

§

Section(SectionHandle)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where diff --git a/cu29/prelude/enum.CopperListState.html b/cu29/prelude/enum.CopperListState.html index 0675361d9..f5599e7ee 100644 --- a/cu29/prelude/enum.CopperListState.html +++ b/cu29/prelude/enum.CopperListState.html @@ -1,4 +1,4 @@ -CopperListState in cu29::prelude - Rust

Enum CopperListState

Source
pub enum CopperListState {
+CopperListState in cu29::prelude - Rust

Enum CopperListState

Source
pub enum CopperListState {
     Free,
     Initialized,
     Processing,
diff --git a/cu29/prelude/enum.CuExecutionUnit.html b/cu29/prelude/enum.CuExecutionUnit.html
index d7528569a..fe2e78356 100644
--- a/cu29/prelude/enum.CuExecutionUnit.html
+++ b/cu29/prelude/enum.CuExecutionUnit.html
@@ -1,4 +1,4 @@
-CuExecutionUnit in cu29::prelude - Rust

Enum CuExecutionUnit

Source
pub enum CuExecutionUnit {
+CuExecutionUnit in cu29::prelude - Rust

Enum CuExecutionUnit

Source
pub enum CuExecutionUnit {
     Step(CuExecutionStep),
     Loop(CuExecutionLoop),
 }
Expand description

This structure represents a step in the execution plan.

diff --git a/cu29/prelude/enum.CuHandleInner.html b/cu29/prelude/enum.CuHandleInner.html index 8371fe112..c1c865cbd 100644 --- a/cu29/prelude/enum.CuHandleInner.html +++ b/cu29/prelude/enum.CuHandleInner.html @@ -1,11 +1,11 @@ -CuHandleInner in cu29::prelude - Rust

Enum CuHandleInner

Source
pub enum CuHandleInner<T>
where +CuHandleInner in cu29::prelude - Rust

Enum CuHandleInner

Source
pub enum CuHandleInner<T>
where T: Debug,
{ Pooled(ReusableOwned<T>), Detached(T), }
Expand description

A Handle to a Buffer. For onboard usages, the buffer should be Pooled (ie, coming from a preallocated pool). The Detached version is for offline usages where we don’t really need a pool to deserialize them.

-

Variants§

§

Pooled(ReusableOwned<T>)

§

Detached(T)

Methods from Deref<Target = [<T as ArrayLike>::Element]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where +

Variants§

§

Pooled(ReusableOwned<T>)

§

Detached(T)

Methods from Deref<Target = [<T as ArrayLike>::Element]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Copy,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Copies the elements from src to self, returning a mutable reference to the now initialized contents of self.

If T does not implement Copy, use write_clone_of_slice instead.

@@ -37,7 +37,7 @@
§Examples
} assert_eq!(vec, src);
-
Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where +

Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Clone,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Clones the elements from src to self, returning a mutable reference to the now initialized contents of self. Any already initialized elements will not be dropped.

@@ -72,7 +72,7 @@
§Examples
} assert_eq!(vec, src);
-

Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

+
Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

§Examples
@@ -85,7 +85,7 @@
§Examples
let val1 = u16::from_ne_bytes(bytes[0..2].try_into().unwrap()); let val2 = u16::from_ne_bytes(bytes[2..4].try_into().unwrap()); assert_eq!(&[val1, val2], &[0x1234u16, 0x5678u16]);
-

Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially +

Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

@@ -102,7 +102,7 @@
§Examples
} else { assert_eq!(vals, &[0x1234u16, 0x5678u16]); }

-
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

+
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

§Safety

It is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state. Calling this when the content is not yet @@ -115,12 +115,12 @@

§Safety
requirement the compiler knows about it is that the data pointer must be non-null. Dropping such a Vec<T> however will cause undefined behaviour.

-
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

+
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state.

-
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

+
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the diff --git a/cu29/prelude/enum.CuTaskCallbackState.html b/cu29/prelude/enum.CuTaskCallbackState.html index ae8b97537..033d8d5c6 100644 --- a/cu29/prelude/enum.CuTaskCallbackState.html +++ b/cu29/prelude/enum.CuTaskCallbackState.html @@ -1,4 +1,4 @@ -CuTaskCallbackState in cu29::prelude - Rust

Enum CuTaskCallbackState

Source
pub enum CuTaskCallbackState<'cl, I, O>
where +CuTaskCallbackState in cu29::prelude - Rust

Enum CuTaskCallbackState

Source
pub enum CuTaskCallbackState<'cl, I, O>
where I: CuMsgPack<'cl>, O: CuMsgPack<'cl>,
{ New(Option<ComponentConfig>), diff --git a/cu29/prelude/enum.CuTaskState.html b/cu29/prelude/enum.CuTaskState.html index db9e07e38..4974006ad 100644 --- a/cu29/prelude/enum.CuTaskState.html +++ b/cu29/prelude/enum.CuTaskState.html @@ -1,4 +1,4 @@ -CuTaskState in cu29::prelude - Rust

Enum CuTaskState

Source
pub enum CuTaskState {
+CuTaskState in cu29::prelude - Rust

Enum CuTaskState

Source
pub enum CuTaskState {
     Start,
     Preprocess,
     Process,
diff --git a/cu29/prelude/enum.CuTaskType.html b/cu29/prelude/enum.CuTaskType.html
index c88e4af5a..bdfb47be3 100644
--- a/cu29/prelude/enum.CuTaskType.html
+++ b/cu29/prelude/enum.CuTaskType.html
@@ -1,4 +1,4 @@
-CuTaskType in cu29::prelude - Rust

Enum CuTaskType

Source
pub enum CuTaskType {
+CuTaskType in cu29::prelude - Rust

Enum CuTaskType

Source
pub enum CuTaskType {
     Source,
     Regular,
     Sink,
diff --git a/cu29/prelude/enum.Decision.html b/cu29/prelude/enum.Decision.html
index e583a2d55..377c52b7a 100644
--- a/cu29/prelude/enum.Decision.html
+++ b/cu29/prelude/enum.Decision.html
@@ -1,4 +1,4 @@
-Decision in cu29::prelude - Rust

Enum Decision

Source
pub enum Decision {
+Decision in cu29::prelude - Rust

Enum Decision

Source
pub enum Decision {
     Abort,
     Ignore,
     Shutdown,
diff --git a/cu29/prelude/enum.SimOverride.html b/cu29/prelude/enum.SimOverride.html
index d6795734e..6d082e1d5 100644
--- a/cu29/prelude/enum.SimOverride.html
+++ b/cu29/prelude/enum.SimOverride.html
@@ -1,4 +1,4 @@
-SimOverride in cu29::prelude - Rust

Enum SimOverride

Source
pub enum SimOverride {
+SimOverride in cu29::prelude - Rust

Enum SimOverride

Source
pub enum SimOverride {
     ExecutedBySim,
     ExecuteByRuntime,
     Errored(String),
diff --git a/cu29/prelude/enum.Tov.html b/cu29/prelude/enum.Tov.html
index aa80231ed..b398badde 100644
--- a/cu29/prelude/enum.Tov.html
+++ b/cu29/prelude/enum.Tov.html
@@ -1,4 +1,4 @@
-Tov in cu29::prelude - Rust

Enum Tov

pub enum Tov {
+Tov in cu29::prelude - Rust

Enum Tov

pub enum Tov {
     None,
     Time(CuDuration),
     Range(CuTimeRange),
diff --git a/cu29/prelude/enum.UnifiedLogType.html b/cu29/prelude/enum.UnifiedLogType.html
index 67dad34bf..620d8e907 100644
--- a/cu29/prelude/enum.UnifiedLogType.html
+++ b/cu29/prelude/enum.UnifiedLogType.html
@@ -1,4 +1,4 @@
-UnifiedLogType in cu29::prelude - Rust

Enum UnifiedLogType

pub enum UnifiedLogType {
+UnifiedLogType in cu29::prelude - Rust

Enum UnifiedLogType

pub enum UnifiedLogType {
     Empty,
     StructuredLogLine,
     CopperList,
diff --git a/cu29/prelude/enum.UnifiedLogger.html b/cu29/prelude/enum.UnifiedLogger.html
index eff7a1aa5..93233a13b 100644
--- a/cu29/prelude/enum.UnifiedLogger.html
+++ b/cu29/prelude/enum.UnifiedLogger.html
@@ -1,4 +1,4 @@
-UnifiedLogger in cu29::prelude - Rust

Enum UnifiedLogger

pub enum UnifiedLogger {
+UnifiedLogger in cu29::prelude - Rust

Enum UnifiedLogger

pub enum UnifiedLogger {
     Read(UnifiedLoggerRead),
     Write(UnifiedLoggerWrite),
 }
Expand description

Holder of the read or write side of the datalogger.

diff --git a/cu29/prelude/enum.Value.html b/cu29/prelude/enum.Value.html index f0ffd5bf5..5f13ae3dd 100644 --- a/cu29/prelude/enum.Value.html +++ b/cu29/prelude/enum.Value.html @@ -1,4 +1,4 @@ -Value in cu29::prelude - Rust

Enum Value

Source
pub enum Value {
+Value in cu29::prelude - Rust

Enum Value

Source
pub enum Value {
 
Show 20 variants Bool(bool), U8(u8), U16(u16), diff --git a/cu29/prelude/fn.compute_runtime_plan.html b/cu29/prelude/fn.compute_runtime_plan.html index ab00996a6..807bc8e1b 100644 --- a/cu29/prelude/fn.compute_runtime_plan.html +++ b/cu29/prelude/fn.compute_runtime_plan.html @@ -1,4 +1,4 @@ -compute_runtime_plan in cu29::prelude - Rust

Function compute_runtime_plan

Source
pub fn compute_runtime_plan(
+compute_runtime_plan in cu29::prelude - Rust

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 pluggable.

diff --git a/cu29/prelude/fn.default_log_index_dir.html b/cu29/prelude/fn.default_log_index_dir.html index b1524d807..a2503fa5b 100644 --- a/cu29/prelude/fn.default_log_index_dir.html +++ b/cu29/prelude/fn.default_log_index_dir.html @@ -1,2 +1,2 @@ -default_log_index_dir in cu29::prelude - Rust

Function default_log_index_dir

pub fn default_log_index_dir() -> PathBuf
Expand description

Convenience function to returns the default path for the log index directory.

+default_log_index_dir in cu29::prelude - Rust

Function default_log_index_dir

pub fn default_log_index_dir() -> PathBuf
Expand description

Convenience function to returns the default path for the log index directory.

\ No newline at end of file diff --git a/cu29/prelude/fn.find_task_type_for_id.html b/cu29/prelude/fn.find_task_type_for_id.html index 4fb451316..5ddec1b5e 100644 --- a/cu29/prelude/fn.find_task_type_for_id.html +++ b/cu29/prelude/fn.find_task_type_for_id.html @@ -1,4 +1,4 @@ -find_task_type_for_id in cu29::prelude - Rust

Function find_task_type_for_id

Source
pub fn find_task_type_for_id(
+find_task_type_for_id in cu29::prelude - Rust

Function find_task_type_for_id

Source
pub fn find_task_type_for_id(
     graph: &StableGraph<Node, Cnx>,
     node_id: u32,
 ) -> CuTaskType
\ No newline at end of file diff --git a/cu29/prelude/fn.format_logline.html b/cu29/prelude/fn.format_logline.html index 409e277e8..d18a86e0c 100644 --- a/cu29/prelude/fn.format_logline.html +++ b/cu29/prelude/fn.format_logline.html @@ -1,4 +1,4 @@ -format_logline in cu29::prelude - Rust

Function format_logline

pub fn format_logline(
+format_logline in cu29::prelude - Rust

Function format_logline

pub fn format_logline(
     time: CuDuration,
     format_str: &str,
     params: &[String],
diff --git a/cu29/prelude/fn.log.html b/cu29/prelude/fn.log.html
index c155c889c..70b746237 100644
--- a/cu29/prelude/fn.log.html
+++ b/cu29/prelude/fn.log.html
@@ -1,3 +1,3 @@
-log in cu29::prelude - Rust

Function log

pub fn log(entry: &mut CuLogEntry) -> Result<(), CuError>
Expand description

Function called from generated code to log data. +log in cu29::prelude - Rust

Function log

pub fn log(entry: &mut CuLogEntry) -> Result<(), CuError>
Expand description

Function called from generated code to log data. It moves entry by design, it will be absorbed in the queue.

\ No newline at end of file diff --git a/cu29/prelude/fn.log_debug_mode.html b/cu29/prelude/fn.log_debug_mode.html index 04ca370d3..6ee6f9bcc 100644 --- a/cu29/prelude/fn.log_debug_mode.html +++ b/cu29/prelude/fn.log_debug_mode.html @@ -1,4 +1,4 @@ -log_debug_mode in cu29::prelude - Rust

Function log_debug_mode

pub fn log_debug_mode(
+log_debug_mode in cu29::prelude - Rust

Function log_debug_mode

pub fn log_debug_mode(
     entry: &mut CuLogEntry,
     format_str: &str,
     param_names: &[&str],
diff --git a/cu29/prelude/fn.pools_statistics.html b/cu29/prelude/fn.pools_statistics.html
index 7ff686230..4578f86c7 100644
--- a/cu29/prelude/fn.pools_statistics.html
+++ b/cu29/prelude/fn.pools_statistics.html
@@ -1,3 +1,3 @@
-pools_statistics in cu29::prelude - Rust

Function pools_statistics

Source
pub fn pools_statistics() -> SmallVec<[(ArrayString<64>, usize, usize, usize); 16]>
Expand description

Get the list of pools and their statistics. +pools_statistics in cu29::prelude - Rust

Function pools_statistics

Source
pub fn pools_statistics() -> SmallVec<[(ArrayString<64>, usize, usize, usize); 16]>
Expand description

Get the list of pools and their statistics. We use SmallVec here to avoid heap allocations while the stack is running.

\ No newline at end of file diff --git a/cu29/prelude/fn.read_configuration.html b/cu29/prelude/fn.read_configuration.html index a34b82fcf..0b94b2bd1 100644 --- a/cu29/prelude/fn.read_configuration.html +++ b/cu29/prelude/fn.read_configuration.html @@ -1,2 +1,2 @@ -read_configuration in cu29::prelude - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a file.

+read_configuration in cu29::prelude - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a file.

\ No newline at end of file diff --git a/cu29/prelude/fn.read_configuration_str.html b/cu29/prelude/fn.read_configuration_str.html index ae16fedfa..d78ed1de8 100644 --- a/cu29/prelude/fn.read_configuration_str.html +++ b/cu29/prelude/fn.read_configuration_str.html @@ -1,4 +1,4 @@ -read_configuration_str in cu29::prelude - Rust

Function read_configuration_str

Source
pub fn read_configuration_str(
+read_configuration_str in cu29::prelude - Rust

Function read_configuration_str

Source
pub fn read_configuration_str(
     config_content: String,
 ) -> Result<CuConfig, CuError>
Expand description

Read a copper configuration from a String.

\ No newline at end of file diff --git a/cu29/prelude/fn.read_interned_strings.html b/cu29/prelude/fn.read_interned_strings.html index 2cdbf1e30..2c8b78f05 100644 --- a/cu29/prelude/fn.read_interned_strings.html +++ b/cu29/prelude/fn.read_interned_strings.html @@ -1,2 +1,2 @@ -read_interned_strings in cu29::prelude - Rust

Function read_interned_strings

pub fn read_interned_strings(index: &Path) -> Result<Vec<String>, CuError>
Expand description

Rebuild the interned string index in memory.

+read_interned_strings in cu29::prelude - Rust

Function read_interned_strings

pub fn read_interned_strings(index: &Path) -> Result<Vec<String>, CuError>
Expand description

Rebuild the interned string index in memory.

\ No newline at end of file diff --git a/cu29/prelude/fn.rebuild_logline.html b/cu29/prelude/fn.rebuild_logline.html index 179028cfd..6fb745ec4 100644 --- a/cu29/prelude/fn.rebuild_logline.html +++ b/cu29/prelude/fn.rebuild_logline.html @@ -1,4 +1,4 @@ -rebuild_logline in cu29::prelude - Rust

Function rebuild_logline

pub fn rebuild_logline(
+rebuild_logline in cu29::prelude - Rust

Function rebuild_logline

pub fn rebuild_logline(
     all_interned_strings: &[String],
     entry: &CuLogEntry,
 ) -> Result<String, CuError>
Expand description

Rebuild a log line from the interned strings and the CuLogEntry. diff --git a/cu29/prelude/fn.stream_write.html b/cu29/prelude/fn.stream_write.html index 909a1830d..9335549d7 100644 --- a/cu29/prelude/fn.stream_write.html +++ b/cu29/prelude/fn.stream_write.html @@ -1,4 +1,4 @@ -stream_write in cu29::prelude - Rust

Function stream_write

pub fn stream_write<E>(
+stream_write in cu29::prelude - Rust

Function stream_write

pub fn stream_write<E>(
     logger: Arc<Mutex<UnifiedLoggerWrite>>,
     entry_type: UnifiedLogType,
     minimum_allocation_amount: usize,
diff --git a/cu29/prelude/fn.to_value.html b/cu29/prelude/fn.to_value.html
index 6146b5b6e..e24ff351e 100644
--- a/cu29/prelude/fn.to_value.html
+++ b/cu29/prelude/fn.to_value.html
@@ -1,2 +1,2 @@
-to_value in cu29::prelude - Rust

Function to_value

Source
pub fn to_value<T>(value: T) -> Result<Value, SerializerError>
where +to_value in cu29::prelude - Rust

Function to_value

Source
pub fn to_value<T>(value: T) -> Result<Value, SerializerError>
where T: Serialize,
\ No newline at end of file diff --git a/cu29/prelude/index.html b/cu29/prelude/index.html index 10e5ca86a..c28aef5da 100644 --- a/cu29/prelude/index.html +++ b/cu29/prelude/index.html @@ -1,4 +1,4 @@ -cu29::prelude - Rust

Module prelude

Source

Modules§

config
This module defines the configuration of the copper runtime. +cu29::prelude - Rust

Module prelude

Source

Modules§

config
This module defines the configuration of the copper runtime. The configuration is a directed graph where nodes are tasks and edges are connections between tasks. The configuration is serialized in the RON format. The configuration is used to generate the runtime code at compile time.
copperlist
CopperList is the main data structure used by Copper to communicate between tasks. diff --git a/cu29/prelude/macro.debug.html b/cu29/prelude/macro.debug.html index b567530e6..f20a9da19 100644 --- a/cu29/prelude/macro.debug.html +++ b/cu29/prelude/macro.debug.html @@ -1,4 +1,4 @@ -debug in cu29::prelude - Rust

Macro debug

Source
debug!() { /* proc-macro */ }
Expand description

This macro is used to log a message with parameters. +debug in cu29::prelude - Rust

Macro debug

Source
debug!() { /* proc-macro */ }
Expand description

This macro is used to log a message with parameters. The first parameter is a string literal that represents the message to be logged. Only {} is supported as a placeholder for parameters. The rest of the parameters are the values to be logged. diff --git a/cu29/prelude/macro.gen_cumsgs.html b/cu29/prelude/macro.gen_cumsgs.html index 71b070f32..681d9cd8f 100644 --- a/cu29/prelude/macro.gen_cumsgs.html +++ b/cu29/prelude/macro.gen_cumsgs.html @@ -1,4 +1,4 @@ -gen_cumsgs in cu29::prelude - Rust

Macro gen_cumsgs

Source
gen_cumsgs!() { /* proc-macro */ }
Expand description

Generates the CopperList content type from a config. +gen_cumsgs in cu29::prelude - Rust

Macro gen_cumsgs

Source
gen_cumsgs!() { /* proc-macro */ }
Expand description

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:

\ No newline at end of file diff --git a/cu29/prelude/macro.input_msg.html b/cu29/prelude/macro.input_msg.html index 88dde9965..b99dd585e 100644 --- a/cu29/prelude/macro.input_msg.html +++ b/cu29/prelude/macro.input_msg.html @@ -1,4 +1,4 @@ -input_msg in cu29::prelude - Rust

Macro input_msg

Source
macro_rules! input_msg {
+input_msg in cu29::prelude - Rust

Macro input_msg

Source
macro_rules! input_msg {
     ($lifetime:lifetime, $ty:ty) => { ... };
     ($lifetime:lifetime, $($ty:ty),*) => { ... };
 }
\ No newline at end of file diff --git a/cu29/prelude/macro.output_msg.html b/cu29/prelude/macro.output_msg.html index f3e783395..8c38852dd 100644 --- a/cu29/prelude/macro.output_msg.html +++ b/cu29/prelude/macro.output_msg.html @@ -1,3 +1,3 @@ -output_msg in cu29::prelude - Rust

Macro output_msg

Source
macro_rules! output_msg {
+output_msg in cu29::prelude - Rust

Macro output_msg

Source
macro_rules! output_msg {
     ($lifetime:lifetime, $ty:ty) => { ... };
 }
\ No newline at end of file diff --git a/cu29/prelude/monitoring/enum.CuTaskState.html b/cu29/prelude/monitoring/enum.CuTaskState.html index bf7cf2508..bd2a0a9c0 100644 --- a/cu29/prelude/monitoring/enum.CuTaskState.html +++ b/cu29/prelude/monitoring/enum.CuTaskState.html @@ -1,4 +1,4 @@ -CuTaskState in cu29::prelude::monitoring - Rust

Enum CuTaskState

Source
pub enum CuTaskState {
+CuTaskState in cu29::prelude::monitoring - Rust

Enum CuTaskState

Source
pub enum CuTaskState {
     Start,
     Preprocess,
     Process,
diff --git a/cu29/prelude/monitoring/enum.Decision.html b/cu29/prelude/monitoring/enum.Decision.html
index 92a36286d..42d216cdc 100644
--- a/cu29/prelude/monitoring/enum.Decision.html
+++ b/cu29/prelude/monitoring/enum.Decision.html
@@ -1,4 +1,4 @@
-Decision in cu29::prelude::monitoring - Rust

Enum Decision

Source
pub enum Decision {
+Decision in cu29::prelude::monitoring - Rust

Enum Decision

Source
pub enum Decision {
     Abort,
     Ignore,
     Shutdown,
diff --git a/cu29/prelude/monitoring/index.html b/cu29/prelude/monitoring/index.html
index 207f1a1ed..791150ad8 100644
--- a/cu29/prelude/monitoring/index.html
+++ b/cu29/prelude/monitoring/index.html
@@ -1,4 +1,4 @@
-cu29::prelude::monitoring - Rust

Module monitoring

Source
Expand description

Some basic internal monitoring tooling Copper uses to monitor itself and the tasks it is running.

+cu29::prelude::monitoring - Rust

Module monitoring

Source
Expand description

Some basic internal monitoring tooling Copper uses to monitor itself and the tasks it is running.

Structs§

CountingAllocator
A simple allocator that counts the number of bytes allocated and deallocated.
CuDurationStatistics
A Specialized statistics object for CuDuration. It will also keep track of the jitter between the values.
LiveStatistics
Accumulative stat object that can give your some real time statistics.
NoMonitor
A do nothing monitor if no monitor is provided. This is basically defining the default behavior of Copper in case of error.
ScopedAllocCounter
A simple struct that counts the number of bytes allocated and deallocated in a scope.

Enums§

CuTaskState
The state of a task.
Decision
Monitor decision to be taken when a task errored out.

Statics§

GLOBAL

Traits§

CuMonitor
Trait to implement a monitoring task.
\ No newline at end of file diff --git a/cu29/prelude/monitoring/static.GLOBAL.html b/cu29/prelude/monitoring/static.GLOBAL.html index 06c414bc2..a9c2832ad 100644 --- a/cu29/prelude/monitoring/static.GLOBAL.html +++ b/cu29/prelude/monitoring/static.GLOBAL.html @@ -1 +1 @@ -GLOBAL in cu29::prelude::monitoring - Rust

Static GLOBAL

Source
pub static GLOBAL: CountingAllocator
\ No newline at end of file +GLOBAL in cu29::prelude::monitoring - Rust

Static GLOBAL

Source
pub static GLOBAL: CountingAllocator
\ No newline at end of file diff --git a/cu29/prelude/monitoring/struct.CountingAllocator.html b/cu29/prelude/monitoring/struct.CountingAllocator.html index f099e0d5f..2b673439f 100644 --- a/cu29/prelude/monitoring/struct.CountingAllocator.html +++ b/cu29/prelude/monitoring/struct.CountingAllocator.html @@ -1,4 +1,4 @@ -CountingAllocator in cu29::prelude::monitoring - Rust

Struct CountingAllocator

Source
pub struct CountingAllocator { /* private fields */ }
Expand description

A simple allocator that counts the number of bytes allocated and deallocated.

+CountingAllocator in cu29::prelude::monitoring - Rust

Struct CountingAllocator

Source
pub struct CountingAllocator { /* private fields */ }
Expand description

A simple allocator that counts the number of bytes allocated and deallocated.

Implementations§

Trait Implementations§

Source§

impl Default for CountingAllocator

Source§

fn default() -> CountingAllocator

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

impl GlobalAlloc for CountingAllocator

Source§

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocates memory as described by the given layout. Read more
Source§

unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout)

Deallocates the block of memory at the given ptr pointer with the given layout. Read more
1.28.0 · Source§

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

Behaves like alloc, but also ensures that the contents are set to zero before being returned. Read more
1.28.0 · Source§

unsafe fn realloc( &self, diff --git a/cu29/prelude/monitoring/struct.CuDurationStatistics.html b/cu29/prelude/monitoring/struct.CuDurationStatistics.html index f1b05bd6d..cd60ce043 100644 --- a/cu29/prelude/monitoring/struct.CuDurationStatistics.html +++ b/cu29/prelude/monitoring/struct.CuDurationStatistics.html @@ -1,4 +1,4 @@ -CuDurationStatistics in cu29::prelude::monitoring - Rust

Struct CuDurationStatistics

Source
pub struct CuDurationStatistics { /* private fields */ }
Expand description

A Specialized statistics object for CuDuration. +CuDurationStatistics in cu29::prelude::monitoring - Rust

Struct CuDurationStatistics

Source
pub struct CuDurationStatistics { /* private fields */ }
Expand description

A Specialized statistics object for CuDuration. It will also keep track of the jitter between the values.

Implementations§

Source§

impl CuDurationStatistics

Source

pub fn new(max: CuDuration) -> CuDurationStatistics

Source

pub fn min(&self) -> CuDuration

Source

pub fn max(&self) -> CuDuration

Source

pub fn mean(&self) -> CuDuration

Source

pub fn percentile(&self, percentile: f64) -> CuDuration

Source

pub fn stddev(&self) -> CuDuration

Source

pub fn len(&self) -> u64

Source

pub fn is_empty(&self) -> bool

Source

pub fn jitter_min(&self) -> CuDuration

Source

pub fn jitter_max(&self) -> CuDuration

Source

pub fn jitter_mean(&self) -> CuDuration

Source

pub fn jitter_stddev(&self) -> CuDuration

Source

pub fn jitter_percentile(&self, percentile: f64) -> CuDuration

Source

pub fn record(&mut self, value: CuDuration)

Source

pub fn reset(&mut self)

Trait Implementations§

Source§

impl Clone for CuDurationStatistics

Source§

fn clone(&self) -> CuDurationStatistics

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 CuDurationStatistics

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29/prelude/monitoring/struct.LiveStatistics.html b/cu29/prelude/monitoring/struct.LiveStatistics.html index b768596b9..457f399ae 100644 --- a/cu29/prelude/monitoring/struct.LiveStatistics.html +++ b/cu29/prelude/monitoring/struct.LiveStatistics.html @@ -1,4 +1,4 @@ -LiveStatistics in cu29::prelude::monitoring - Rust

Struct LiveStatistics

Source
pub struct LiveStatistics { /* private fields */ }
Expand description

Accumulative stat object that can give your some real time statistics.

+LiveStatistics in cu29::prelude::monitoring - Rust

Struct LiveStatistics

Source
pub struct LiveStatistics { /* private fields */ }
Expand description

Accumulative stat object that can give your some real time statistics.

Implementations§

Source§

impl LiveStatistics

Source

pub fn new_unbounded() -> LiveStatistics

Source

pub fn new_with_max(max: u64) -> LiveStatistics

Source

pub fn min(&self) -> u64

Source

pub fn max(&self) -> u64

Source

pub fn mean(&self) -> f64

Source

pub fn percentile(&self, percentile: f64) -> u64

Source

pub fn record(&mut self, value: u64)

Adds a value to the statistics.

Source

pub fn len(&self) -> u64

Source

pub fn is_empty(&self) -> bool

Source

pub fn reset(&mut self)

Trait Implementations§

Source§

impl Clone for LiveStatistics

Source§

fn clone(&self) -> LiveStatistics

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 LiveStatistics

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29/prelude/monitoring/struct.NoMonitor.html b/cu29/prelude/monitoring/struct.NoMonitor.html index 0db6f6499..02111140e 100644 --- a/cu29/prelude/monitoring/struct.NoMonitor.html +++ b/cu29/prelude/monitoring/struct.NoMonitor.html @@ -1,4 +1,4 @@ -NoMonitor in cu29::prelude::monitoring - Rust

Struct NoMonitor

Source
pub struct NoMonitor {}
Expand description

A do nothing monitor if no monitor is provided. +NoMonitor in cu29::prelude::monitoring - Rust

Struct NoMonitor

Source
pub struct NoMonitor {}
Expand description

A do nothing monitor if no monitor is provided. This is basically defining the default behavior of Copper in case of error.

Trait Implementations§

Source§

impl CuMonitor for NoMonitor

Source§

fn new( _config: &CuConfig, diff --git a/cu29/prelude/monitoring/struct.ScopedAllocCounter.html b/cu29/prelude/monitoring/struct.ScopedAllocCounter.html index e9703cf53..863ef0cb4 100644 --- a/cu29/prelude/monitoring/struct.ScopedAllocCounter.html +++ b/cu29/prelude/monitoring/struct.ScopedAllocCounter.html @@ -1,4 +1,4 @@ -ScopedAllocCounter in cu29::prelude::monitoring - Rust

Struct ScopedAllocCounter

Source
pub struct ScopedAllocCounter { /* private fields */ }
Expand description

A simple struct that counts the number of bytes allocated and deallocated in a scope.

+ScopedAllocCounter in cu29::prelude::monitoring - Rust

Struct ScopedAllocCounter

Source
pub struct ScopedAllocCounter { /* private fields */ }
Expand description

A simple struct that counts the number of bytes allocated and deallocated in a scope.

Implementations§

Source§

impl ScopedAllocCounter

Source

pub fn new() -> ScopedAllocCounter

Source

pub fn get_allocated(&self) -> usize

Returns the total number of bytes allocated in the current scope since the creation of this ScopedAllocCounter.

§Example
diff --git a/cu29/prelude/monitoring/trait.CuMonitor.html b/cu29/prelude/monitoring/trait.CuMonitor.html index def165c6a..1e40dcf26 100644 --- a/cu29/prelude/monitoring/trait.CuMonitor.html +++ b/cu29/prelude/monitoring/trait.CuMonitor.html @@ -1,4 +1,4 @@ -CuMonitor in cu29::prelude::monitoring - Rust

Trait CuMonitor

Source
pub trait CuMonitor: Sized {
+CuMonitor in cu29::prelude::monitoring - Rust

Trait CuMonitor

Source
pub trait CuMonitor: Sized {
     // Required methods
     fn new(
         config: &CuConfig,
diff --git a/cu29/prelude/payload/index.html b/cu29/prelude/payload/index.html
index c105e745c..b227743ec 100644
--- a/cu29/prelude/payload/index.html
+++ b/cu29/prelude/payload/index.html
@@ -1 +1 @@
-cu29::prelude::payload - Rust

Module payload

Source

Structs§

CuArray
Copper friendly wrapper for a fixed size array.
\ No newline at end of file +cu29::prelude::payload - Rust

Module payload

Source

Structs§

CuArray
Copper friendly wrapper for a fixed size array.
\ No newline at end of file diff --git a/cu29/prelude/payload/struct.CuArray.html b/cu29/prelude/payload/struct.CuArray.html index a8d4d18b3..0e9cd7cdd 100644 --- a/cu29/prelude/payload/struct.CuArray.html +++ b/cu29/prelude/payload/struct.CuArray.html @@ -1,4 +1,4 @@ -CuArray in cu29::prelude::payload - Rust

Struct CuArray

Source
pub struct CuArray<T, const N: usize> { /* private fields */ }
Expand description

Copper friendly wrapper for a fixed size array.

+CuArray in cu29::prelude::payload - Rust

Struct CuArray

Source
pub struct CuArray<T, const N: usize> { /* private fields */ }
Expand description

Copper friendly wrapper for a fixed size array.

Implementations§

Source§

impl<T, const N: usize> CuArray<T, N>

Source

pub fn new() -> CuArray<T, N>

Source

pub fn fill_from_iter<I>(&mut self, iter: I)
where I: IntoIterator<Item = T>,

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn as_slice(&self) -> &[T]

Source

pub fn capacity(&self) -> usize

Trait Implementations§

Source§

impl<T, const N: usize> Clone for CuArray<T, N>
where T: Clone,

Source§

fn clone(&self) -> CuArray<T, N>

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<T, const N: usize> Debug for CuArray<T, N>
where diff --git a/cu29/prelude/pool/enum.CuHandleInner.html b/cu29/prelude/pool/enum.CuHandleInner.html index 4e7138bbb..d34c78977 100644 --- a/cu29/prelude/pool/enum.CuHandleInner.html +++ b/cu29/prelude/pool/enum.CuHandleInner.html @@ -1,11 +1,11 @@ -CuHandleInner in cu29::prelude::pool - Rust

Enum CuHandleInner

Source
pub enum CuHandleInner<T>
where +CuHandleInner in cu29::prelude::pool - Rust

Enum CuHandleInner

Source
pub enum CuHandleInner<T>
where T: Debug,
{ Pooled(ReusableOwned<T>), Detached(T), }
Expand description

A Handle to a Buffer. For onboard usages, the buffer should be Pooled (ie, coming from a preallocated pool). The Detached version is for offline usages where we don’t really need a pool to deserialize them.

-

Variants§

§

Pooled(ReusableOwned<T>)

§

Detached(T)

Methods from Deref<Target = [<T as ArrayLike>::Element]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where +

Variants§

§

Pooled(ReusableOwned<T>)

§

Detached(T)

Methods from Deref<Target = [<T as ArrayLike>::Element]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Copy,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Copies the elements from src to self, returning a mutable reference to the now initialized contents of self.

If T does not implement Copy, use write_clone_of_slice instead.

@@ -37,7 +37,7 @@
§Examples
} assert_eq!(vec, src);
-

Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where +

Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Clone,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Clones the elements from src to self, returning a mutable reference to the now initialized contents of self. Any already initialized elements will not be dropped.

@@ -72,7 +72,7 @@
§Examples
} assert_eq!(vec, src);
-
Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

+
Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

§Examples
@@ -85,7 +85,7 @@
§Examples
let val1 = u16::from_ne_bytes(bytes[0..2].try_into().unwrap()); let val2 = u16::from_ne_bytes(bytes[2..4].try_into().unwrap()); assert_eq!(&[val1, val2], &[0x1234u16, 0x5678u16]);

-
Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially +

Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

@@ -102,7 +102,7 @@
§Examples
} else { assert_eq!(vals, &[0x1234u16, 0x5678u16]); }
-
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

+
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

§Safety

It is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state. Calling this when the content is not yet @@ -115,12 +115,12 @@

§Safety
requirement the compiler knows about it is that the data pointer must be non-null. Dropping such a Vec<T> however will cause undefined behaviour.

-
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

+
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state.

-
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

+
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the diff --git a/cu29/prelude/pool/fn.pools_statistics.html b/cu29/prelude/pool/fn.pools_statistics.html index bccf85e2d..b0759e380 100644 --- a/cu29/prelude/pool/fn.pools_statistics.html +++ b/cu29/prelude/pool/fn.pools_statistics.html @@ -1,3 +1,3 @@ -pools_statistics in cu29::prelude::pool - Rust

Function pools_statistics

Source
pub fn pools_statistics() -> SmallVec<[(ArrayString<64>, usize, usize, usize); 16]>
Expand description

Get the list of pools and their statistics. +pools_statistics in cu29::prelude::pool - Rust

Function pools_statistics

Source
pub fn pools_statistics() -> SmallVec<[(ArrayString<64>, usize, usize, usize); 16]>
Expand description

Get the list of pools and their statistics. We use SmallVec here to avoid heap allocations while the stack is running.

\ No newline at end of file diff --git a/cu29/prelude/pool/index.html b/cu29/prelude/pool/index.html index 55f329ced..1b0475ce7 100644 --- a/cu29/prelude/pool/index.html +++ b/cu29/prelude/pool/index.html @@ -1,4 +1,4 @@ -cu29::prelude::pool - Rust

Module pool

Source

Structs§

AlignedBuffer
A buffer that is aligned to a specific size with the Element of type E.
CuHandle
A shareable handle to an Array coming from a pool (either host or device).
CuHostMemoryPool
A pool of host memory buffers.

Enums§

CuHandleInner
A Handle to a Buffer. +cu29::prelude::pool - Rust

Module pool

Source

Structs§

AlignedBuffer
A buffer that is aligned to a specific size with the Element of type E.
CuHandle
A shareable handle to an Array coming from a pool (either host or device).
CuHostMemoryPool
A pool of host memory buffers.

Enums§

CuHandleInner
A Handle to a Buffer. For onboard usages, the buffer should be Pooled (ie, coming from a preallocated pool). The Detached version is for offline usages where we don’t really need a pool to deserialize them.

Traits§

ArrayLike
CuPool
A CuPool is a pool of buffers that can be shared between different parts of the code. Handles can be stored locally in the tasks and shared between them.
DeviceCuPool
A device memory pool can copy data from a device to a host memory pool on top.
ElementType
Basic Type that can be used in a buffer in a CuPool.
PoolMonitor
Trait for a Pool to exposed to be monitored by the monitoring API.

Functions§

pools_statistics
Get the list of pools and their statistics. diff --git a/cu29/prelude/pool/struct.AlignedBuffer.html b/cu29/prelude/pool/struct.AlignedBuffer.html index 4f6d5312a..ae9578a95 100644 --- a/cu29/prelude/pool/struct.AlignedBuffer.html +++ b/cu29/prelude/pool/struct.AlignedBuffer.html @@ -1,7 +1,7 @@ -AlignedBuffer in cu29::prelude::pool - Rust

Struct AlignedBuffer

Source
pub struct AlignedBuffer<E>
where +AlignedBuffer in cu29::prelude::pool - Rust

Struct AlignedBuffer

Source
pub struct AlignedBuffer<E>
where E: ElementType,
{ /* private fields */ }
Expand description

A buffer that is aligned to a specific size with the Element of type E.

Implementations§

Source§

impl<E> AlignedBuffer<E>
where - E: ElementType,

Source

pub fn new(num_elements: usize, alignment: usize) -> AlignedBuffer<E>

Methods from Deref<Target = [E]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where + E: ElementType,

Source

pub fn new(num_elements: usize, alignment: usize) -> AlignedBuffer<E>

Methods from Deref<Target = [E]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Copy,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Copies the elements from src to self, returning a mutable reference to the now initialized contents of self.

If T does not implement Copy, use write_clone_of_slice instead.

@@ -33,7 +33,7 @@
§Examples
} assert_eq!(vec, src);
-
Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where +

Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Clone,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Clones the elements from src to self, returning a mutable reference to the now initialized contents of self. Any already initialized elements will not be dropped.

@@ -68,7 +68,7 @@
§Examples
} assert_eq!(vec, src);
-
Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

+
Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

§Examples
@@ -81,7 +81,7 @@
§Examples
let val1 = u16::from_ne_bytes(bytes[0..2].try_into().unwrap()); let val2 = u16::from_ne_bytes(bytes[2..4].try_into().unwrap()); assert_eq!(&[val1, val2], &[0x1234u16, 0x5678u16]);
-
Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially +

Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

@@ -98,7 +98,7 @@
§Examples
} else { assert_eq!(vals, &[0x1234u16, 0x5678u16]); }
-
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

+
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

§Safety

It is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state. Calling this when the content is not yet @@ -111,12 +111,12 @@

§Safety
requirement the compiler knows about it is that the data pointer must be non-null. Dropping such a Vec<T> however will cause undefined behaviour.

-
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

+
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state.

-
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

+
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the diff --git a/cu29/prelude/pool/struct.CuHandle.html b/cu29/prelude/pool/struct.CuHandle.html index 593b6711c..636df844b 100644 --- a/cu29/prelude/pool/struct.CuHandle.html +++ b/cu29/prelude/pool/struct.CuHandle.html @@ -1,4 +1,4 @@ -CuHandle in cu29::prelude::pool - Rust

Struct CuHandle

Source
pub struct CuHandle<T>(/* private fields */)
+CuHandle in cu29::prelude::pool - Rust

Struct CuHandle

Source
pub struct CuHandle<T>(/* private fields */)
 where
     T: ArrayLike;
Expand description

A shareable handle to an Array coming from a pool (either host or device).

Implementations§

Source§

impl<T> CuHandle<T>
where diff --git a/cu29/prelude/pool/struct.CuHostMemoryPool.html b/cu29/prelude/pool/struct.CuHostMemoryPool.html index 4cfd302fb..40b93cb56 100644 --- a/cu29/prelude/pool/struct.CuHostMemoryPool.html +++ b/cu29/prelude/pool/struct.CuHostMemoryPool.html @@ -1,4 +1,4 @@ -CuHostMemoryPool in cu29::prelude::pool - Rust

Struct CuHostMemoryPool

Source
pub struct CuHostMemoryPool<T> { /* private fields */ }
Expand description

A pool of host memory buffers.

+CuHostMemoryPool in cu29::prelude::pool - Rust

Struct CuHostMemoryPool

Source
pub struct CuHostMemoryPool<T> { /* private fields */ }
Expand description

A pool of host memory buffers.

Implementations§

Source§

impl<T> CuHostMemoryPool<T>
where T: ArrayLike + 'static,

Source

pub fn new<F>( id: &str, diff --git a/cu29/prelude/pool/trait.ArrayLike.html b/cu29/prelude/pool/trait.ArrayLike.html index 09dfbb53e..df3dbf76b 100644 --- a/cu29/prelude/pool/trait.ArrayLike.html +++ b/cu29/prelude/pool/trait.ArrayLike.html @@ -1,4 +1,4 @@ -ArrayLike in cu29::prelude::pool - Rust

Trait ArrayLike

Source
pub trait ArrayLike:
+ArrayLike in cu29::prelude::pool - Rust

Trait ArrayLike

Source
pub trait ArrayLike:
     Deref<Target = [Self::Element]>
     + DerefMut
     + Debug
diff --git a/cu29/prelude/pool/trait.CuPool.html b/cu29/prelude/pool/trait.CuPool.html
index b257a484a..35fd84f84 100644
--- a/cu29/prelude/pool/trait.CuPool.html
+++ b/cu29/prelude/pool/trait.CuPool.html
@@ -1,4 +1,4 @@
-CuPool in cu29::prelude::pool - Rust

Trait CuPool

Source
pub trait CuPool<T>: PoolMonitor
where +CuPool in cu29::prelude::pool - Rust

Trait CuPool

Source
pub trait CuPool<T>: PoolMonitor
where T: ArrayLike,
{ // Required methods fn acquire(&self) -> Option<CuHandle<T>>; diff --git a/cu29/prelude/pool/trait.DeviceCuPool.html b/cu29/prelude/pool/trait.DeviceCuPool.html index 65ad5d0ff..facb9662f 100644 --- a/cu29/prelude/pool/trait.DeviceCuPool.html +++ b/cu29/prelude/pool/trait.DeviceCuPool.html @@ -1,4 +1,4 @@ -DeviceCuPool in cu29::prelude::pool - Rust

Trait DeviceCuPool

Source
pub trait DeviceCuPool<T>: CuPool<T>
where +DeviceCuPool in cu29::prelude::pool - Rust

Trait DeviceCuPool

Source
pub trait DeviceCuPool<T>: CuPool<T>
where T: ArrayLike,
{ // Required method fn copy_to_host_pool<O>( diff --git a/cu29/prelude/pool/trait.ElementType.html b/cu29/prelude/pool/trait.ElementType.html index 7e6334ae8..03d513d4d 100644 --- a/cu29/prelude/pool/trait.ElementType.html +++ b/cu29/prelude/pool/trait.ElementType.html @@ -1,4 +1,4 @@ -ElementType in cu29::prelude::pool - Rust

Trait ElementType

Source
pub trait ElementType:
+ElementType in cu29::prelude::pool - Rust

Trait ElementType

Source
pub trait ElementType:
     Sized
     + Default
     + Copy
diff --git a/cu29/prelude/pool/trait.PoolMonitor.html b/cu29/prelude/pool/trait.PoolMonitor.html
index 6ca8ed428..e35b675bc 100644
--- a/cu29/prelude/pool/trait.PoolMonitor.html
+++ b/cu29/prelude/pool/trait.PoolMonitor.html
@@ -1,4 +1,4 @@
-PoolMonitor in cu29::prelude::pool - Rust

Trait PoolMonitor

Source
pub trait PoolMonitor: Send + Sync {
+PoolMonitor in cu29::prelude::pool - Rust

Trait PoolMonitor

Source
pub trait PoolMonitor: Send + Sync {
     // Required methods
     fn id(&self) -> ArrayString<64>;
     fn space_left(&self) -> usize;
diff --git a/cu29/prelude/simulation/enum.CuTaskCallbackState.html b/cu29/prelude/simulation/enum.CuTaskCallbackState.html
index 9f1f5b111..8275b7a93 100644
--- a/cu29/prelude/simulation/enum.CuTaskCallbackState.html
+++ b/cu29/prelude/simulation/enum.CuTaskCallbackState.html
@@ -1,4 +1,4 @@
-CuTaskCallbackState in cu29::prelude::simulation - Rust

Enum CuTaskCallbackState

Source
pub enum CuTaskCallbackState<'cl, I, O>
where +CuTaskCallbackState in cu29::prelude::simulation - Rust

Enum CuTaskCallbackState

Source
pub enum CuTaskCallbackState<'cl, I, O>
where I: CuMsgPack<'cl>, O: CuMsgPack<'cl>,
{ New(Option<ComponentConfig>), diff --git a/cu29/prelude/simulation/enum.SimOverride.html b/cu29/prelude/simulation/enum.SimOverride.html index 77e31114c..51158925c 100644 --- a/cu29/prelude/simulation/enum.SimOverride.html +++ b/cu29/prelude/simulation/enum.SimOverride.html @@ -1,4 +1,4 @@ -SimOverride in cu29::prelude::simulation - Rust

Enum SimOverride

Source
pub enum SimOverride {
+SimOverride in cu29::prelude::simulation - Rust

Enum SimOverride

Source
pub enum SimOverride {
     ExecutedBySim,
     ExecuteByRuntime,
     Errored(String),
diff --git a/cu29/prelude/simulation/index.html b/cu29/prelude/simulation/index.html
index a14be19ba..30a0f3d12 100644
--- a/cu29/prelude/simulation/index.html
+++ b/cu29/prelude/simulation/index.html
@@ -1,4 +1,4 @@
-cu29::prelude::simulation - Rust

Module simulation

Source
Expand description

§cu29::simulation Module

+cu29::prelude::simulation - Rust

Module simulation

Source
Expand description

§cu29::simulation Module

The cu29::simulation module provides an interface to simulate tasks in Copper-based systems. It offers structures, traits, and enums that enable hooking into the lifecycle of tasks, adapting their behavior, and integrating them with simulated hardware environments.

diff --git a/cu29/prelude/simulation/struct.CuSimSinkTask.html b/cu29/prelude/simulation/struct.CuSimSinkTask.html index d1485a32a..08ead4b6e 100644 --- a/cu29/prelude/simulation/struct.CuSimSinkTask.html +++ b/cu29/prelude/simulation/struct.CuSimSinkTask.html @@ -1,4 +1,4 @@ -CuSimSinkTask in cu29::prelude::simulation - Rust

Struct CuSimSinkTask

Source
pub struct CuSimSinkTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a sink task for the simulations. +CuSimSinkTask in cu29::prelude::simulation - Rust

Struct CuSimSinkTask

Source
pub struct CuSimSinkTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a sink task for the simulations. It basically does nothing in place of a real driver so it won’t try to initialize any hardware.

Trait Implementations§

Source§

impl<'cl, T> CuSinkTask<'cl> for CuSimSinkTask<T>
where T: CuMsgPayload + 'cl,

Source§

type Input = &'cl CuMsg<T>

Source§

fn new(_config: Option<&ComponentConfig>) -> Result<CuSimSinkTask<T>, CuError>
where diff --git a/cu29/prelude/simulation/struct.CuSimSrcTask.html b/cu29/prelude/simulation/struct.CuSimSrcTask.html index c9cd63e83..a17482448 100644 --- a/cu29/prelude/simulation/struct.CuSimSrcTask.html +++ b/cu29/prelude/simulation/struct.CuSimSrcTask.html @@ -1,4 +1,4 @@ -CuSimSrcTask in cu29::prelude::simulation - Rust

Struct CuSimSrcTask

Source
pub struct CuSimSrcTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a source task for the simulations. +CuSimSrcTask in cu29::prelude::simulation - Rust

Struct CuSimSrcTask

Source
pub struct CuSimSrcTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a source task for the simulations. It basically does nothing in place of a real driver so it won’t try to initialize any hardware.

Trait Implementations§

Source§

impl<'cl, T> CuSrcTask<'cl> for CuSimSrcTask<T>
where T: CuMsgPayload + 'cl,

Source§

type Output = &'cl mut CuMsg<T>

Source§

fn new(_config: Option<&ComponentConfig>) -> Result<CuSimSrcTask<T>, CuError>
where diff --git a/cu29/prelude/static.EXTRA_TEXT_LOGGER.html b/cu29/prelude/static.EXTRA_TEXT_LOGGER.html index e9de14284..7973412ce 100644 --- a/cu29/prelude/static.EXTRA_TEXT_LOGGER.html +++ b/cu29/prelude/static.EXTRA_TEXT_LOGGER.html @@ -1 +1 @@ -EXTRA_TEXT_LOGGER in cu29::prelude - Rust

Static EXTRA_TEXT_LOGGER

pub static EXTRA_TEXT_LOGGER: RwLock<Option<Box<dyn Log>>>
\ No newline at end of file +EXTRA_TEXT_LOGGER in cu29::prelude - Rust

Static EXTRA_TEXT_LOGGER

pub static EXTRA_TEXT_LOGGER: RwLock<Option<Box<dyn Log>>>
\ No newline at end of file diff --git a/cu29/prelude/static.GLOBAL.html b/cu29/prelude/static.GLOBAL.html index 7e4645de6..060859411 100644 --- a/cu29/prelude/static.GLOBAL.html +++ b/cu29/prelude/static.GLOBAL.html @@ -1 +1 @@ -GLOBAL in cu29::prelude - Rust

Static GLOBAL

Source
pub static GLOBAL: CountingAllocator
\ No newline at end of file +GLOBAL in cu29::prelude - Rust

Static GLOBAL

Source
pub static GLOBAL: CountingAllocator
\ No newline at end of file diff --git a/cu29/prelude/struct.AlignedBuffer.html b/cu29/prelude/struct.AlignedBuffer.html index 6600a3fe1..e3b8a6fc1 100644 --- a/cu29/prelude/struct.AlignedBuffer.html +++ b/cu29/prelude/struct.AlignedBuffer.html @@ -1,7 +1,7 @@ -AlignedBuffer in cu29::prelude - Rust

Struct AlignedBuffer

Source
pub struct AlignedBuffer<E>
where +AlignedBuffer in cu29::prelude - Rust

Struct AlignedBuffer

Source
pub struct AlignedBuffer<E>
where E: ElementType,
{ /* private fields */ }
Expand description

A buffer that is aligned to a specific size with the Element of type E.

Implementations§

Source§

impl<E> AlignedBuffer<E>
where - E: ElementType,

Source

pub fn new(num_elements: usize, alignment: usize) -> AlignedBuffer<E>

Methods from Deref<Target = [E]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where + E: ElementType,

Source

pub fn new(num_elements: usize, alignment: usize) -> AlignedBuffer<E>

Methods from Deref<Target = [E]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Copy,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Copies the elements from src to self, returning a mutable reference to the now initialized contents of self.

If T does not implement Copy, use write_clone_of_slice instead.

@@ -33,7 +33,7 @@
§Examples
} assert_eq!(vec, src);
-

Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where +

Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Clone,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Clones the elements from src to self, returning a mutable reference to the now initialized contents of self. Any already initialized elements will not be dropped.

@@ -68,7 +68,7 @@
§Examples
} assert_eq!(vec, src);

-

Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

+
Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

§Examples
@@ -81,7 +81,7 @@
§Examples
let val1 = u16::from_ne_bytes(bytes[0..2].try_into().unwrap()); let val2 = u16::from_ne_bytes(bytes[2..4].try_into().unwrap()); assert_eq!(&[val1, val2], &[0x1234u16, 0x5678u16]);

-
Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially +

Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

@@ -98,7 +98,7 @@
§Examples
} else { assert_eq!(vals, &[0x1234u16, 0x5678u16]); }
-
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

+
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

§Safety

It is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state. Calling this when the content is not yet @@ -111,12 +111,12 @@

§Safety
requirement the compiler knows about it is that the data pointer must be non-null. Dropping such a Vec<T> however will cause undefined behaviour.

-
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

+
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state.

-
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

+
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the diff --git a/cu29/prelude/struct.Cnx.html b/cu29/prelude/struct.Cnx.html index 2fba64dbf..37c498bf3 100644 --- a/cu29/prelude/struct.Cnx.html +++ b/cu29/prelude/struct.Cnx.html @@ -1,4 +1,4 @@ -Cnx in cu29::prelude - Rust

Struct Cnx

Source
pub struct Cnx {
+Cnx in cu29::prelude - Rust

Struct Cnx

Source
pub struct Cnx {
     pub msg: String,
     pub batch: Option<u32>,
     pub store: Option<bool>,
diff --git a/cu29/prelude/struct.ComponentConfig.html b/cu29/prelude/struct.ComponentConfig.html
index 965c3ccb8..4a543f6b8 100644
--- a/cu29/prelude/struct.ComponentConfig.html
+++ b/cu29/prelude/struct.ComponentConfig.html
@@ -1,4 +1,4 @@
-ComponentConfig in cu29::prelude - Rust

Struct ComponentConfig

Source
pub struct ComponentConfig(pub HashMap<String, Value>);
Expand description

This is the configuration of a component (like a task config or a monitoring config):w +ComponentConfig in cu29::prelude - Rust

Struct ComponentConfig

Source
pub struct ComponentConfig(pub HashMap<String, Value>);
Expand description

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

Tuple Fields§

§0: HashMap<String, Value>

Implementations§

Source§

impl ComponentConfig

Source

pub fn new() -> ComponentConfig

Source

pub fn get<T>(&self, key: &str) -> Option<T>
where diff --git a/cu29/prelude/struct.CopperContext.html b/cu29/prelude/struct.CopperContext.html index 7e146546c..045e5e75a 100644 --- a/cu29/prelude/struct.CopperContext.html +++ b/cu29/prelude/struct.CopperContext.html @@ -1,4 +1,4 @@ -CopperContext in cu29::prelude - Rust

Struct CopperContext

Source
pub struct CopperContext {
+CopperContext in cu29::prelude - Rust

Struct CopperContext

Source
pub struct CopperContext {
     pub unified_logger: Arc<Mutex<UnifiedLoggerWrite>>,
     pub logger_runtime: LoggerRuntime,
     pub clock: RobotClock,
diff --git a/cu29/prelude/struct.CopperLiskMask.html b/cu29/prelude/struct.CopperLiskMask.html
index 0b84ecebb..230de86d9 100644
--- a/cu29/prelude/struct.CopperLiskMask.html
+++ b/cu29/prelude/struct.CopperLiskMask.html
@@ -1,4 +1,4 @@
-CopperLiskMask in cu29::prelude - Rust

Struct CopperLiskMask

Source
pub struct CopperLiskMask { /* private fields */ }
Expand description

Not implemented yet. +CopperLiskMask in cu29::prelude - Rust

Struct CopperLiskMask

Source
pub struct CopperLiskMask { /* private fields */ }
Expand description

Not implemented yet. This mask will be used to for example filter out necessary regions of a copper list between remote systems.

Trait Implementations§

Source§

impl<'__de> BorrowDecode<'__de> for CopperLiskMask

Source§

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

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

impl Clone for CopperLiskMask

Source§

fn clone(&self) -> CopperLiskMask

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 CopperLiskMask

Source§

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

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

impl Decode for CopperLiskMask

Source§

fn decode<__D>(decoder: &mut __D) -> Result<CopperLiskMask, DecodeError>
where diff --git a/cu29/prelude/struct.CopperList.html b/cu29/prelude/struct.CopperList.html index c93175cd1..7fa66f2c0 100644 --- a/cu29/prelude/struct.CopperList.html +++ b/cu29/prelude/struct.CopperList.html @@ -1,4 +1,4 @@ -CopperList in cu29::prelude - Rust

Struct CopperList

Source
pub struct CopperList<P>
where +CopperList in cu29::prelude - Rust

Struct CopperList

Source
pub struct CopperList<P>
where P: CopperListTuple,
{ pub id: u32, pub msgs: P, diff --git a/cu29/prelude/struct.CountingAllocator.html b/cu29/prelude/struct.CountingAllocator.html index 9f9a47f53..a7c94f91e 100644 --- a/cu29/prelude/struct.CountingAllocator.html +++ b/cu29/prelude/struct.CountingAllocator.html @@ -1,4 +1,4 @@ -CountingAllocator in cu29::prelude - Rust

Struct CountingAllocator

Source
pub struct CountingAllocator { /* private fields */ }
Expand description

A simple allocator that counts the number of bytes allocated and deallocated.

+CountingAllocator in cu29::prelude - Rust

Struct CountingAllocator

Source
pub struct CountingAllocator { /* private fields */ }
Expand description

A simple allocator that counts the number of bytes allocated and deallocated.

Implementations§

Trait Implementations§

Source§

impl Default for CountingAllocator

Source§

fn default() -> CountingAllocator

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

impl GlobalAlloc for CountingAllocator

Source§

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocates memory as described by the given layout. Read more
Source§

unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout)

Deallocates the block of memory at the given ptr pointer with the given layout. Read more
1.28.0 · Source§

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

Behaves like alloc, but also ensures that the contents are set to zero before being returned. Read more
1.28.0 · Source§

unsafe fn realloc( &self, diff --git a/cu29/prelude/struct.CuArray.html b/cu29/prelude/struct.CuArray.html index d5c2d9f7c..dec5439c3 100644 --- a/cu29/prelude/struct.CuArray.html +++ b/cu29/prelude/struct.CuArray.html @@ -1,4 +1,4 @@ -CuArray in cu29::prelude - Rust

Struct CuArray

Source
pub struct CuArray<T, const N: usize> { /* private fields */ }
Expand description

Copper friendly wrapper for a fixed size array.

+CuArray in cu29::prelude - Rust

Struct CuArray

Source
pub struct CuArray<T, const N: usize> { /* private fields */ }
Expand description

Copper friendly wrapper for a fixed size array.

Implementations§

Source§

impl<T, const N: usize> CuArray<T, N>

Source

pub fn new() -> CuArray<T, N>

Source

pub fn fill_from_iter<I>(&mut self, iter: I)
where I: IntoIterator<Item = T>,

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn as_slice(&self) -> &[T]

Source

pub fn capacity(&self) -> usize

Trait Implementations§

Source§

impl<T, const N: usize> Clone for CuArray<T, N>
where T: Clone,

Source§

fn clone(&self) -> CuArray<T, N>

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<T, const N: usize> Debug for CuArray<T, N>
where diff --git a/cu29/prelude/struct.CuCompactString.html b/cu29/prelude/struct.CuCompactString.html index 2dde5f7ba..ab734ae85 100644 --- a/cu29/prelude/struct.CuCompactString.html +++ b/cu29/prelude/struct.CuCompactString.html @@ -1,4 +1,4 @@ -CuCompactString in cu29::prelude - Rust

Struct CuCompactString

Source
pub struct CuCompactString(pub CompactString);

Tuple Fields§

§0: CompactString

Trait Implementations§

Source§

impl<'de> BorrowDecode<'de> for CuCompactString

Source§

fn borrow_decode<D>(decoder: &mut D) -> Result<CuCompactString, DecodeError>
where +CuCompactString in cu29::prelude - Rust

Struct CuCompactString

Source
pub struct CuCompactString(pub CompactString);

Tuple Fields§

§0: CompactString

Trait Implementations§

Source§

impl<'de> BorrowDecode<'de> for CuCompactString

Source§

fn borrow_decode<D>(decoder: &mut D) -> Result<CuCompactString, DecodeError>
where D: BorrowDecoder<'de>,

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

impl Clone for CuCompactString

Source§

fn clone(&self) -> CuCompactString

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 CuCompactString

Source§

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

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

impl Decode for CuCompactString

Source§

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

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

impl Default for CuCompactString

Source§

fn default() -> CuCompactString

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

impl<'de> Deserialize<'de> for CuCompactString

Source§

fn deserialize<__D>( __deserializer: __D, diff --git a/cu29/prelude/struct.CuConfig.html b/cu29/prelude/struct.CuConfig.html index d4441d513..66fd3c396 100644 --- a/cu29/prelude/struct.CuConfig.html +++ b/cu29/prelude/struct.CuConfig.html @@ -1,4 +1,4 @@ -CuConfig in cu29::prelude - Rust

Struct CuConfig

Source
pub struct CuConfig {
+CuConfig in cu29::prelude - Rust

Struct CuConfig

Source
pub struct CuConfig {
     pub graph: StableGraph<Node, Cnx>,
     pub monitor: Option<MonitorConfig>,
     pub logging: Option<LoggingConfig>,
diff --git a/cu29/prelude/struct.CuDuration.html b/cu29/prelude/struct.CuDuration.html
index 14ef9cbc4..dded80950 100644
--- a/cu29/prelude/struct.CuDuration.html
+++ b/cu29/prelude/struct.CuDuration.html
@@ -1,4 +1,4 @@
-CuDuration in cu29::prelude - Rust

Struct CuDuration

pub struct CuDuration(pub u64);
Expand description

For Robot times, the underlying type is a u64 representing nanoseconds. +CuDuration in cu29::prelude - Rust

Struct CuDuration

pub struct CuDuration(pub u64);
Expand description

For Robot times, the underlying type is a u64 representing nanoseconds. It is always positive to simplify the reasoning on the user side.

Tuple Fields§

§0: u64

Implementations§

§

impl CuDuration

pub const MIN: CuDuration

pub const MAX: CuDuration

pub fn max(&self, p0: CuDuration) -> CuDuration

pub fn min(&self, p0: CuDuration) -> CuDuration

pub fn as_nanos(&self) -> u64

Trait Implementations§

§

impl Add for CuDuration

§

type Output = CuDuration

The resulting type after applying the + operator.
§

fn add(self, rhs: CuDuration) -> <CuDuration as Add>::Output

Performs the + operation. Read more
§

impl AddAssign for CuDuration

§

fn add_assign(&mut self, rhs: CuDuration)

Performs the += operation. Read more
§

impl<'de> BorrowDecode<'de> for CuDuration

§

fn borrow_decode<D>(decoder: &mut D) -> Result<CuDuration, DecodeError>
where D: BorrowDecoder<'de>,

Attempt to decode this type with the given BorrowDecode.
§

impl Clone for CuDuration

§

fn clone(&self) -> CuDuration

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
§

impl Debug for CuDuration

§

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

Formats the value using the given formatter. Read more
§

impl Decode for CuDuration

§

fn decode<D>(decoder: &mut D) -> Result<CuDuration, DecodeError>
where diff --git a/cu29/prelude/struct.CuDurationStatistics.html b/cu29/prelude/struct.CuDurationStatistics.html index 76d3c4f5e..101a78844 100644 --- a/cu29/prelude/struct.CuDurationStatistics.html +++ b/cu29/prelude/struct.CuDurationStatistics.html @@ -1,4 +1,4 @@ -CuDurationStatistics in cu29::prelude - Rust

Struct CuDurationStatistics

Source
pub struct CuDurationStatistics { /* private fields */ }
Expand description

A Specialized statistics object for CuDuration. +CuDurationStatistics in cu29::prelude - Rust

Struct CuDurationStatistics

Source
pub struct CuDurationStatistics { /* private fields */ }
Expand description

A Specialized statistics object for CuDuration. It will also keep track of the jitter between the values.

Implementations§

Source§

impl CuDurationStatistics

Source

pub fn new(max: CuDuration) -> CuDurationStatistics

Source

pub fn min(&self) -> CuDuration

Source

pub fn max(&self) -> CuDuration

Source

pub fn mean(&self) -> CuDuration

Source

pub fn percentile(&self, percentile: f64) -> CuDuration

Source

pub fn stddev(&self) -> CuDuration

Source

pub fn len(&self) -> u64

Source

pub fn is_empty(&self) -> bool

Source

pub fn jitter_min(&self) -> CuDuration

Source

pub fn jitter_max(&self) -> CuDuration

Source

pub fn jitter_mean(&self) -> CuDuration

Source

pub fn jitter_stddev(&self) -> CuDuration

Source

pub fn jitter_percentile(&self, percentile: f64) -> CuDuration

Source

pub fn record(&mut self, value: CuDuration)

Source

pub fn reset(&mut self)

Trait Implementations§

Source§

impl Clone for CuDurationStatistics

Source§

fn clone(&self) -> CuDurationStatistics

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 CuDurationStatistics

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29/prelude/struct.CuError.html b/cu29/prelude/struct.CuError.html index 4b4f5815f..3142d6415 100644 --- a/cu29/prelude/struct.CuError.html +++ b/cu29/prelude/struct.CuError.html @@ -1,4 +1,4 @@ -CuError in cu29::prelude - Rust

Struct CuError

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

Common copper Error type.

+CuError in cu29::prelude - Rust

Struct CuError

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

Common copper Error type.

Implementations§

§

impl CuError

pub fn new_with_cause(message: &str, cause: impl Error) -> CuError

pub fn add_cause(self, context: &str) -> CuError

Trait Implementations§

§

impl Clone for CuError

§

fn clone(&self) -> CuError

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
§

impl Debug for CuError

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for CuError

§

fn deserialize<__D>( __deserializer: __D, ) -> Result<CuError, <__D as Deserializer<'de>>::Error>
where diff --git a/cu29/prelude/struct.CuExecutionLoop.html b/cu29/prelude/struct.CuExecutionLoop.html index 23955c0e1..d6af895eb 100644 --- a/cu29/prelude/struct.CuExecutionLoop.html +++ b/cu29/prelude/struct.CuExecutionLoop.html @@ -1,4 +1,4 @@ -CuExecutionLoop in cu29::prelude - Rust

Struct CuExecutionLoop

Source
pub struct CuExecutionLoop {
+CuExecutionLoop in cu29::prelude - Rust

Struct CuExecutionLoop

Source
pub struct CuExecutionLoop {
     pub steps: Vec<CuExecutionUnit>,
     pub loop_count: Option<u32>,
 }
Expand description

This structure represents a loop in the execution plan. diff --git a/cu29/prelude/struct.CuExecutionStep.html b/cu29/prelude/struct.CuExecutionStep.html index 8dced0750..a8f96afcf 100644 --- a/cu29/prelude/struct.CuExecutionStep.html +++ b/cu29/prelude/struct.CuExecutionStep.html @@ -1,4 +1,4 @@ -CuExecutionStep in cu29::prelude - Rust

Struct CuExecutionStep

Source
pub struct CuExecutionStep {
+CuExecutionStep in cu29::prelude - Rust

Struct CuExecutionStep

Source
pub struct CuExecutionStep {
     pub node_id: u32,
     pub node: Node,
     pub task_type: CuTaskType,
diff --git a/cu29/prelude/struct.CuHandle.html b/cu29/prelude/struct.CuHandle.html
index a320d140c..293f059af 100644
--- a/cu29/prelude/struct.CuHandle.html
+++ b/cu29/prelude/struct.CuHandle.html
@@ -1,4 +1,4 @@
-CuHandle in cu29::prelude - Rust

Struct CuHandle

Source
pub struct CuHandle<T>(/* private fields */)
+CuHandle in cu29::prelude - Rust

Struct CuHandle

Source
pub struct CuHandle<T>(/* private fields */)
 where
     T: ArrayLike;
Expand description

A shareable handle to an Array coming from a pool (either host or device).

Implementations§

Source§

impl<T> CuHandle<T>
where diff --git a/cu29/prelude/struct.CuHostMemoryPool.html b/cu29/prelude/struct.CuHostMemoryPool.html index bb7357959..988d838a7 100644 --- a/cu29/prelude/struct.CuHostMemoryPool.html +++ b/cu29/prelude/struct.CuHostMemoryPool.html @@ -1,4 +1,4 @@ -CuHostMemoryPool in cu29::prelude - Rust

Struct CuHostMemoryPool

Source
pub struct CuHostMemoryPool<T> { /* private fields */ }
Expand description

A pool of host memory buffers.

+CuHostMemoryPool in cu29::prelude - Rust

Struct CuHostMemoryPool

Source
pub struct CuHostMemoryPool<T> { /* private fields */ }
Expand description

A pool of host memory buffers.

Implementations§

Source§

impl<T> CuHostMemoryPool<T>
where T: ArrayLike + 'static,

Source

pub fn new<F>( id: &str, diff --git a/cu29/prelude/struct.CuListsManager.html b/cu29/prelude/struct.CuListsManager.html index 2f8924806..26a776055 100644 --- a/cu29/prelude/struct.CuListsManager.html +++ b/cu29/prelude/struct.CuListsManager.html @@ -1,4 +1,4 @@ -CuListsManager in cu29::prelude - Rust

Struct CuListsManager

Source
pub struct CuListsManager<P, const N: usize>
where +CuListsManager in cu29::prelude - Rust

Struct CuListsManager

Source
pub struct CuListsManager<P, const N: usize>
where P: CopperListTuple,
{ /* private fields */ }
Expand description

This structure maintains the entire memory needed by Copper for one loop for the inter tasks communication within a process. P or Payload is typically a Tuple of various types of messages that are exchanged between tasks. N is the maximum number of in flight Copper List the runtime can support.

diff --git a/cu29/prelude/struct.CuLogEntry.html b/cu29/prelude/struct.CuLogEntry.html index 1eee76622..8b72b24d7 100644 --- a/cu29/prelude/struct.CuLogEntry.html +++ b/cu29/prelude/struct.CuLogEntry.html @@ -1,4 +1,4 @@ -CuLogEntry in cu29::prelude - Rust

Struct CuLogEntry

pub struct CuLogEntry {
+CuLogEntry in cu29::prelude - Rust

Struct CuLogEntry

pub struct CuLogEntry {
     pub time: CuDuration,
     pub msg_index: u32,
     pub paramname_indexes: SmallVec<[u32; 10]>,
diff --git a/cu29/prelude/struct.CuMsg.html b/cu29/prelude/struct.CuMsg.html
index 15da766ae..3d4bafffd 100644
--- a/cu29/prelude/struct.CuMsg.html
+++ b/cu29/prelude/struct.CuMsg.html
@@ -1,4 +1,4 @@
-CuMsg in cu29::prelude - Rust

Struct CuMsg

Source
pub struct CuMsg<T>
where +CuMsg in cu29::prelude - Rust

Struct CuMsg

Source
pub struct CuMsg<T>
where T: CuMsgPayload,
{ pub metadata: CuMsgMetadata, /* private fields */ diff --git a/cu29/prelude/struct.CuMsgMetadata.html b/cu29/prelude/struct.CuMsgMetadata.html index 7c3f51da9..5cbedcbce 100644 --- a/cu29/prelude/struct.CuMsgMetadata.html +++ b/cu29/prelude/struct.CuMsgMetadata.html @@ -1,4 +1,4 @@ -CuMsgMetadata in cu29::prelude - Rust

Struct CuMsgMetadata

Source
pub struct CuMsgMetadata {
+CuMsgMetadata in cu29::prelude - Rust

Struct CuMsgMetadata

Source
pub struct CuMsgMetadata {
     pub process_time: PartialCuTimeRange,
     pub tov: Tov,
     pub status_txt: CuCompactString,
diff --git a/cu29/prelude/struct.CuRuntime.html b/cu29/prelude/struct.CuRuntime.html
index f0d550b28..66a5d7bb8 100644
--- a/cu29/prelude/struct.CuRuntime.html
+++ b/cu29/prelude/struct.CuRuntime.html
@@ -1,4 +1,4 @@
-CuRuntime in cu29::prelude - Rust

Struct CuRuntime

Source
pub struct CuRuntime<CT, P, M, const NBCL: usize>
where +CuRuntime in cu29::prelude - Rust

Struct CuRuntime

Source
pub struct CuRuntime<CT, P, M, const NBCL: usize>{
     pub tasks: CT,
diff --git a/cu29/prelude/struct.CuSimSinkTask.html b/cu29/prelude/struct.CuSimSinkTask.html
index 27d53213b..67e3eb4c8 100644
--- a/cu29/prelude/struct.CuSimSinkTask.html
+++ b/cu29/prelude/struct.CuSimSinkTask.html
@@ -1,4 +1,4 @@
-CuSimSinkTask in cu29::prelude - Rust

Struct CuSimSinkTask

Source
pub struct CuSimSinkTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a sink task for the simulations. +CuSimSinkTask in cu29::prelude - Rust

Struct CuSimSinkTask

Source
pub struct CuSimSinkTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a sink task for the simulations. It basically does nothing in place of a real driver so it won’t try to initialize any hardware.

Trait Implementations§

Source§

impl<'cl, T> CuSinkTask<'cl> for CuSimSinkTask<T>
where T: CuMsgPayload + 'cl,

Source§

type Input = &'cl CuMsg<T>

Source§

fn new(_config: Option<&ComponentConfig>) -> Result<CuSimSinkTask<T>, CuError>
where diff --git a/cu29/prelude/struct.CuSimSrcTask.html b/cu29/prelude/struct.CuSimSrcTask.html index cdd0cae89..a6dd282c1 100644 --- a/cu29/prelude/struct.CuSimSrcTask.html +++ b/cu29/prelude/struct.CuSimSrcTask.html @@ -1,4 +1,4 @@ -CuSimSrcTask in cu29::prelude - Rust

Struct CuSimSrcTask

Source
pub struct CuSimSrcTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a source task for the simulations. +CuSimSrcTask in cu29::prelude - Rust

Struct CuSimSrcTask

Source
pub struct CuSimSrcTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a source task for the simulations. It basically does nothing in place of a real driver so it won’t try to initialize any hardware.

Trait Implementations§

Source§

impl<'cl, T> CuSrcTask<'cl> for CuSimSrcTask<T>
where T: CuMsgPayload + 'cl,

Source§

type Output = &'cl mut CuMsg<T>

Source§

fn new(_config: Option<&ComponentConfig>) -> Result<CuSimSrcTask<T>, CuError>
where diff --git a/cu29/prelude/struct.CuTimeRange.html b/cu29/prelude/struct.CuTimeRange.html index b85901a4e..17ec22851 100644 --- a/cu29/prelude/struct.CuTimeRange.html +++ b/cu29/prelude/struct.CuTimeRange.html @@ -1,4 +1,4 @@ -CuTimeRange in cu29::prelude - Rust

Struct CuTimeRange

pub struct CuTimeRange {
+CuTimeRange in cu29::prelude - Rust

Struct CuTimeRange

pub struct CuTimeRange {
     pub start: CuDuration,
     pub end: CuDuration,
 }
Expand description

Represents a time range.

diff --git a/cu29/prelude/struct.Instant.html b/cu29/prelude/struct.Instant.html index 498a80646..f15ce47f3 100644 --- a/cu29/prelude/struct.Instant.html +++ b/cu29/prelude/struct.Instant.html @@ -1,4 +1,4 @@ -Instant in cu29::prelude - Rust

Struct Instant

pub struct Instant(/* private fields */);
Expand description

A point-in-time wall-clock measurement.

+Instant in cu29::prelude - Rust

Struct Instant

pub struct Instant(/* private fields */);
Expand description

A point-in-time wall-clock measurement.

Mimics most of the functionality of std::time::Instant but provides an additional method for using the “recent time” feature of quanta.

§Monotonicity

diff --git a/cu29/prelude/struct.LiveStatistics.html b/cu29/prelude/struct.LiveStatistics.html index 861b5e33d..3842d0df3 100644 --- a/cu29/prelude/struct.LiveStatistics.html +++ b/cu29/prelude/struct.LiveStatistics.html @@ -1,4 +1,4 @@ -LiveStatistics in cu29::prelude - Rust

Struct LiveStatistics

Source
pub struct LiveStatistics { /* private fields */ }
Expand description

Accumulative stat object that can give your some real time statistics.

+LiveStatistics in cu29::prelude - Rust

Struct LiveStatistics

Source
pub struct LiveStatistics { /* private fields */ }
Expand description

Accumulative stat object that can give your some real time statistics.

Implementations§

Source§

impl LiveStatistics

Source

pub fn new_unbounded() -> LiveStatistics

Source

pub fn new_with_max(max: u64) -> LiveStatistics

Source

pub fn min(&self) -> u64

Source

pub fn max(&self) -> u64

Source

pub fn mean(&self) -> f64

Source

pub fn percentile(&self, percentile: f64) -> u64

Source

pub fn record(&mut self, value: u64)

Adds a value to the statistics.

Source

pub fn len(&self) -> u64

Source

pub fn is_empty(&self) -> bool

Source

pub fn reset(&mut self)

Trait Implementations§

Source§

impl Clone for LiveStatistics

Source§

fn clone(&self) -> LiveStatistics

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 LiveStatistics

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29/prelude/struct.LoggerRuntime.html b/cu29/prelude/struct.LoggerRuntime.html index 0d50d7b71..55de877be 100644 --- a/cu29/prelude/struct.LoggerRuntime.html +++ b/cu29/prelude/struct.LoggerRuntime.html @@ -1,4 +1,4 @@ -LoggerRuntime in cu29::prelude - Rust

Struct LoggerRuntime

pub struct LoggerRuntime {}
Expand description

The lifetime of this struct is the lifetime of the logger.

+LoggerRuntime in cu29::prelude - Rust

Struct LoggerRuntime

pub struct LoggerRuntime {}
Expand description

The lifetime of this struct is the lifetime of the logger.

Implementations§

§

impl LoggerRuntime

pub fn init( clock: RobotClock, destination: impl WriteStream<CuLogEntry> + 'static, diff --git a/cu29/prelude/struct.LoggingConfig.html b/cu29/prelude/struct.LoggingConfig.html index 3d83f12b1..54bd5faeb 100644 --- a/cu29/prelude/struct.LoggingConfig.html +++ b/cu29/prelude/struct.LoggingConfig.html @@ -1,4 +1,4 @@ -LoggingConfig in cu29::prelude - Rust

Struct LoggingConfig

Source
pub struct LoggingConfig {
+LoggingConfig in cu29::prelude - Rust

Struct LoggingConfig

Source
pub struct LoggingConfig {
     pub slab_size_mib: Option<u64>,
     pub section_size_mib: Option<u64>,
     pub enable_task_logging: bool,
diff --git a/cu29/prelude/struct.MonitorConfig.html b/cu29/prelude/struct.MonitorConfig.html
index b6897cfc3..3750e61b9 100644
--- a/cu29/prelude/struct.MonitorConfig.html
+++ b/cu29/prelude/struct.MonitorConfig.html
@@ -1,4 +1,4 @@
-MonitorConfig in cu29::prelude - Rust

Struct MonitorConfig

Source
pub struct MonitorConfig { /* private fields */ }

Implementations§

Trait Implementations§

Source§

impl Clone for MonitorConfig

Source§

fn clone(&self) -> MonitorConfig

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 MonitorConfig

Source§

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

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

impl Default for MonitorConfig

Source§

fn default() -> MonitorConfig

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

impl<'de> Deserialize<'de> for MonitorConfig

Source§

fn deserialize<__D>( +MonitorConfig in cu29::prelude - Rust

Struct MonitorConfig

Source
pub struct MonitorConfig { /* private fields */ }

Implementations§

Trait Implementations§

Source§

impl Clone for MonitorConfig

Source§

fn clone(&self) -> MonitorConfig

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 MonitorConfig

Source§

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

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

impl Default for MonitorConfig

Source§

fn default() -> MonitorConfig

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

impl<'de> Deserialize<'de> for MonitorConfig

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<MonitorConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MonitorConfig

Source§

fn serialize<__S>( diff --git a/cu29/prelude/struct.NoMonitor.html b/cu29/prelude/struct.NoMonitor.html index 5c8dae744..02ac36d35 100644 --- a/cu29/prelude/struct.NoMonitor.html +++ b/cu29/prelude/struct.NoMonitor.html @@ -1,4 +1,4 @@ -NoMonitor in cu29::prelude - Rust

Struct NoMonitor

Source
pub struct NoMonitor {}
Expand description

A do nothing monitor if no monitor is provided. +NoMonitor in cu29::prelude - Rust

Struct NoMonitor

Source
pub struct NoMonitor {}
Expand description

A do nothing monitor if no monitor is provided. This is basically defining the default behavior of Copper in case of error.

Trait Implementations§

Source§

impl CuMonitor for NoMonitor

Source§

fn new( _config: &CuConfig, diff --git a/cu29/prelude/struct.Node.html b/cu29/prelude/struct.Node.html index f7daa9e3c..c11c00c3f 100644 --- a/cu29/prelude/struct.Node.html +++ b/cu29/prelude/struct.Node.html @@ -1,4 +1,4 @@ -Node in cu29::prelude - Rust

Struct Node

Source
pub struct Node { /* private fields */ }
Expand description

A node in the configuration graph. +Node in cu29::prelude - Rust

Struct Node

Source
pub struct Node { /* private fields */ }
Expand description

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

Implementations§

Source§

impl Node

Source

pub fn new(id: &str, ptype: &str) -> Node

Source

pub fn get_id(&self) -> String

Source

pub fn set_type(self, name: Option<String>) -> Node

Source

pub fn get_type(&self) -> &str

Source

pub fn get_instance_config(&self) -> Option<&ComponentConfig>

Source

pub fn get_param<T>(&self, key: &str) -> Option<T>
where T: From<Value>,

Source

pub fn set_param<T>(&mut self, key: &str, value: T)
where diff --git a/cu29/prelude/struct.NullLog.html b/cu29/prelude/struct.NullLog.html index 9c566d9b4..e3881d27b 100644 --- a/cu29/prelude/struct.NullLog.html +++ b/cu29/prelude/struct.NullLog.html @@ -1,4 +1,4 @@ -NullLog in cu29::prelude - Rust

Struct NullLog

pub struct NullLog;

Trait Implementations§

§

impl Log for NullLog

§

fn enabled(&self, _metadata: &Metadata<'_>) -> bool

Determines if a log message with the specified metadata would be +NullLog in cu29::prelude - Rust

Struct NullLog

pub struct NullLog;

Trait Implementations§

§

impl Log for NullLog

§

fn enabled(&self, _metadata: &Metadata<'_>) -> bool

Determines if a log message with the specified metadata would be logged. Read more
§

fn log(&self, _record: &Record<'_>)

Logs the Record. Read more
§

fn flush(&self)

Flushes any buffered records. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where diff --git a/cu29/prelude/struct.OptionCuTime.html b/cu29/prelude/struct.OptionCuTime.html index 75158a55c..3c94a9fce 100644 --- a/cu29/prelude/struct.OptionCuTime.html +++ b/cu29/prelude/struct.OptionCuTime.html @@ -1,4 +1,4 @@ -OptionCuTime in cu29::prelude - Rust

Struct OptionCuTime

pub struct OptionCuTime(/* private fields */);
Expand description

Homebrewed Option<CuDuration> to avoid using 128bits just to represent an Option.

+OptionCuTime in cu29::prelude - Rust

Struct OptionCuTime

pub struct OptionCuTime(/* private fields */);
Expand description

Homebrewed Option<CuDuration> to avoid using 128bits just to represent an Option.

Implementations§

§

impl OptionCuTime

pub fn is_none(&self) -> bool

pub fn none() -> OptionCuTime

pub fn unwrap(self) -> CuDuration

Trait Implementations§

§

impl<'__de> BorrowDecode<'__de> for OptionCuTime

§

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

Attempt to decode this type with the given BorrowDecode.
§

impl Clone for OptionCuTime

§

fn clone(&self) -> OptionCuTime

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
§

impl Debug for OptionCuTime

§

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

Formats the value using the given formatter. Read more
§

impl Decode for OptionCuTime

§

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

Attempt to decode this type with the given Decode.
§

impl Default for OptionCuTime

§

fn default() -> OptionCuTime

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

impl<'de> Deserialize<'de> for OptionCuTime

§

fn deserialize<__D>( diff --git a/cu29/prelude/struct.OwningIoWriter.html b/cu29/prelude/struct.OwningIoWriter.html index 040fec87c..8a71ad885 100644 --- a/cu29/prelude/struct.OwningIoWriter.html +++ b/cu29/prelude/struct.OwningIoWriter.html @@ -1,4 +1,4 @@ -OwningIoWriter in cu29::prelude - Rust

Struct OwningIoWriter

pub struct OwningIoWriter<W>
where +OwningIoWriter in cu29::prelude - Rust

Struct OwningIoWriter

pub struct OwningIoWriter<W>
where W: Write,
{ /* private fields */ }

Implementations§

§

impl<W> OwningIoWriter<W>
where W: Write,

pub fn new(writer: W) -> OwningIoWriter<W>

pub fn bytes_written(&self) -> usize

pub fn flush(&mut self) -> Result<(), EncodeError>

Trait Implementations§

§

impl<W> Writer for OwningIoWriter<W>
where W: Write,

§

fn write(&mut self, bytes: &[u8]) -> Result<(), EncodeError>

Write bytes to the underlying writer. Exactly bytes.len() bytes must be written, or else an error should be returned.

Auto Trait Implementations§

§

impl<W> Freeze for OwningIoWriter<W>
where diff --git a/cu29/prelude/struct.PartialCuTimeRange.html b/cu29/prelude/struct.PartialCuTimeRange.html index 26bfa9534..a8671f988 100644 --- a/cu29/prelude/struct.PartialCuTimeRange.html +++ b/cu29/prelude/struct.PartialCuTimeRange.html @@ -1,4 +1,4 @@ -PartialCuTimeRange in cu29::prelude - Rust

Struct PartialCuTimeRange

pub struct PartialCuTimeRange {
+PartialCuTimeRange in cu29::prelude - Rust

Struct PartialCuTimeRange

pub struct PartialCuTimeRange {
     pub start: OptionCuTime,
     pub end: OptionCuTime,
 }
Expand description

Represents a time range with possible undefined start or end or both.

diff --git a/cu29/prelude/struct.RobotClock.html b/cu29/prelude/struct.RobotClock.html index b939ad55f..53507e95a 100644 --- a/cu29/prelude/struct.RobotClock.html +++ b/cu29/prelude/struct.RobotClock.html @@ -1,4 +1,4 @@ -RobotClock in cu29::prelude - Rust

Struct RobotClock

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

A running Robot clock. +RobotClock in cu29::prelude - Rust

Struct RobotClock

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

A running Robot clock. The clock is a monotonic clock that starts at an arbitrary reference time. It is clone resilient, ie a clone will be the same clock, even when mocked.

Implementations§

§

impl RobotClock

pub fn new() -> RobotClock

Creates a RobotClock using now as its reference time. diff --git a/cu29/prelude/struct.RobotClockMock.html b/cu29/prelude/struct.RobotClockMock.html index 3145cc92a..2702fccee 100644 --- a/cu29/prelude/struct.RobotClockMock.html +++ b/cu29/prelude/struct.RobotClockMock.html @@ -1,4 +1,4 @@ -RobotClockMock in cu29::prelude - Rust

Struct RobotClockMock

pub struct RobotClockMock(/* private fields */);
Expand description

A mock clock that can be controlled by the user.

+RobotClockMock in cu29::prelude - Rust

Struct RobotClockMock

pub struct RobotClockMock(/* private fields */);
Expand description

A mock clock that can be controlled by the user.

Implementations§

§

impl RobotClockMock

pub fn increment(&self, amount: Duration)

pub fn decrement(&self, amount: Duration)

Decrements the time by the given amount. Be careful this brakes the monotonicity of the clock.

pub fn value(&self) -> u64

Gets the current value of time.

diff --git a/cu29/prelude/struct.ScopedAllocCounter.html b/cu29/prelude/struct.ScopedAllocCounter.html index c69d1a574..6eb0cee67 100644 --- a/cu29/prelude/struct.ScopedAllocCounter.html +++ b/cu29/prelude/struct.ScopedAllocCounter.html @@ -1,4 +1,4 @@ -ScopedAllocCounter in cu29::prelude - Rust

Struct ScopedAllocCounter

Source
pub struct ScopedAllocCounter { /* private fields */ }
Expand description

A simple struct that counts the number of bytes allocated and deallocated in a scope.

+ScopedAllocCounter in cu29::prelude - Rust

Struct ScopedAllocCounter

Source
pub struct ScopedAllocCounter { /* private fields */ }
Expand description

A simple struct that counts the number of bytes allocated and deallocated in a scope.

Implementations§

Source§

impl ScopedAllocCounter

Source

pub fn new() -> ScopedAllocCounter

Source

pub fn get_allocated(&self) -> usize

Returns the total number of bytes allocated in the current scope since the creation of this ScopedAllocCounter.

§Example
diff --git a/cu29/prelude/struct.SectionHandle.html b/cu29/prelude/struct.SectionHandle.html index 5137deaf1..77b7b3577 100644 --- a/cu29/prelude/struct.SectionHandle.html +++ b/cu29/prelude/struct.SectionHandle.html @@ -1,4 +1,4 @@ -SectionHandle in cu29::prelude - Rust

Struct SectionHandle

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

A SectionHandle is a handle to a section in the datalogger. +SectionHandle in cu29::prelude - Rust

Struct SectionHandle

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

A SectionHandle is a handle to a section in the datalogger. It allows to track the lifecycle of a section of the datalogger.

Implementations§

§

impl SectionHandle

pub fn create( section_header: SectionHeader, diff --git a/cu29/prelude/struct.SectionHeader.html b/cu29/prelude/struct.SectionHeader.html index 3b1cebb78..75f777cea 100644 --- a/cu29/prelude/struct.SectionHeader.html +++ b/cu29/prelude/struct.SectionHeader.html @@ -1,4 +1,4 @@ -SectionHeader in cu29::prelude - Rust

Struct SectionHeader

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

Each concurrent sublogger is tracked through a section header. +SectionHeader in cu29::prelude - Rust

Struct SectionHeader

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

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.

Trait Implementations§

§

impl<'__de> BorrowDecode<'__de> for SectionHeader

§

fn borrow_decode<__D>(decoder: &mut __D) -> Result<SectionHeader, DecodeError>
where diff --git a/cu29/prelude/struct.SimpleFileWriter.html b/cu29/prelude/struct.SimpleFileWriter.html index b8dd92954..8b4d841a8 100644 --- a/cu29/prelude/struct.SimpleFileWriter.html +++ b/cu29/prelude/struct.SimpleFileWriter.html @@ -1,4 +1,4 @@ -SimpleFileWriter in cu29::prelude - Rust

Struct SimpleFileWriter

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

This allows this crate to be used outside of Copper (ie. decoupling it from the unifiedlog.

+SimpleFileWriter in cu29::prelude - Rust

Struct SimpleFileWriter

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

This allows this crate to be used outside of Copper (ie. decoupling it from the unifiedlog.

Implementations§

Trait Implementations§

§

impl Debug for SimpleFileWriter

§

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

Formats the value using the given formatter. Read more
§

impl WriteStream<CuLogEntry> for SimpleFileWriter

§

fn log(&mut self, obj: &CuLogEntry) -> Result<(), CuError>

§

fn flush(&mut self) -> Result<(), CuError>

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where diff --git a/cu29/prelude/struct.UnifiedLoggerBuilder.html b/cu29/prelude/struct.UnifiedLoggerBuilder.html index 3b87b7621..70e8240f5 100644 --- a/cu29/prelude/struct.UnifiedLoggerBuilder.html +++ b/cu29/prelude/struct.UnifiedLoggerBuilder.html @@ -1,4 +1,4 @@ -UnifiedLoggerBuilder in cu29::prelude - Rust

Struct UnifiedLoggerBuilder

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

Use this builder to create a new DataLogger.

+UnifiedLoggerBuilder in cu29::prelude - Rust

Struct UnifiedLoggerBuilder

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

Use this builder to create a new DataLogger.

Implementations§

§

impl UnifiedLoggerBuilder

pub fn new() -> UnifiedLoggerBuilder

pub fn file_base_name(self, file_path: &Path) -> UnifiedLoggerBuilder

If “something/toto.copper” is given, it will find or create “something/toto_0.copper”, “something/toto_1.copper” etc.

pub fn preallocated_size(self, preallocated_size: usize) -> UnifiedLoggerBuilder

pub fn write(self, write: bool) -> UnifiedLoggerBuilder

pub fn create(self, create: bool) -> UnifiedLoggerBuilder

pub fn build(self) -> Result<UnifiedLogger, Error>

Trait Implementations§

§

impl Default for UnifiedLoggerBuilder

§

fn default() -> UnifiedLoggerBuilder

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

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29/prelude/struct.UnifiedLoggerIOReader.html b/cu29/prelude/struct.UnifiedLoggerIOReader.html index 019e00a6d..8f3516125 100644 --- a/cu29/prelude/struct.UnifiedLoggerIOReader.html +++ b/cu29/prelude/struct.UnifiedLoggerIOReader.html @@ -1,4 +1,4 @@ -UnifiedLoggerIOReader in cu29::prelude - Rust

Struct UnifiedLoggerIOReader

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

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

+UnifiedLoggerIOReader in cu29::prelude - Rust

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/struct.UnifiedLoggerRead.html b/cu29/prelude/struct.UnifiedLoggerRead.html index a216abf83..cd934c638 100644 --- a/cu29/prelude/struct.UnifiedLoggerRead.html +++ b/cu29/prelude/struct.UnifiedLoggerRead.html @@ -1,4 +1,4 @@ -UnifiedLoggerRead in cu29::prelude - Rust

Struct UnifiedLoggerRead

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

A read side of the datalogger.

+UnifiedLoggerRead in cu29::prelude - Rust

Struct UnifiedLoggerRead

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

A read side of the datalogger.

Implementations§

§

impl UnifiedLoggerRead

pub fn new(base_file_path: &Path) -> Result<UnifiedLoggerRead, Error>

pub fn read_next_section_type( &mut self, datalogtype: UnifiedLogType, diff --git a/cu29/prelude/struct.UnifiedLoggerWrite.html b/cu29/prelude/struct.UnifiedLoggerWrite.html index c2bd44d29..49b90d77b 100644 --- a/cu29/prelude/struct.UnifiedLoggerWrite.html +++ b/cu29/prelude/struct.UnifiedLoggerWrite.html @@ -1,4 +1,4 @@ -UnifiedLoggerWrite in cu29::prelude - Rust

Struct UnifiedLoggerWrite

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

A write side of the datalogger.

+UnifiedLoggerWrite in cu29::prelude - Rust

Struct UnifiedLoggerWrite

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

A write side of the datalogger.

Implementations§

§

impl UnifiedLoggerWrite

pub fn flush_section(&mut self, section: &mut SectionHandle)

pub fn stats(&self) -> (usize, Vec<usize>, usize)

Trait Implementations§

§

impl Drop for UnifiedLoggerWrite

§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where diff --git a/cu29/prelude/trait.ArrayLike.html b/cu29/prelude/trait.ArrayLike.html index e726f7112..8792e68a0 100644 --- a/cu29/prelude/trait.ArrayLike.html +++ b/cu29/prelude/trait.ArrayLike.html @@ -1,4 +1,4 @@ -ArrayLike in cu29::prelude - Rust

Trait ArrayLike

Source
pub trait ArrayLike:
+ArrayLike in cu29::prelude - Rust

Trait ArrayLike

Source
pub trait ArrayLike:
     Deref<Target = [Self::Element]>
     + DerefMut
     + Debug
diff --git a/cu29/prelude/trait.ClockProvider.html b/cu29/prelude/trait.ClockProvider.html
index 288699aa6..b9292db79 100644
--- a/cu29/prelude/trait.ClockProvider.html
+++ b/cu29/prelude/trait.ClockProvider.html
@@ -1,4 +1,4 @@
-ClockProvider in cu29::prelude - Rust

Trait ClockProvider

pub trait ClockProvider {
+ClockProvider in cu29::prelude - Rust

Trait ClockProvider

pub trait ClockProvider {
     // Required method
     fn get_clock(&self) -> RobotClock;
 }
Expand description

A trait to provide a clock to the runtime.

diff --git a/cu29/prelude/trait.CopperListTuple.html b/cu29/prelude/trait.CopperListTuple.html index eacec2102..1255e535f 100644 --- a/cu29/prelude/trait.CopperListTuple.html +++ b/cu29/prelude/trait.CopperListTuple.html @@ -1,4 +1,4 @@ -CopperListTuple in cu29::prelude - Rust

Trait CopperListTuple

pub trait CopperListTuple:
+CopperListTuple in cu29::prelude - Rust

Trait CopperListTuple

pub trait CopperListTuple:
     Sized
     + Encode
     + Decode
diff --git a/cu29/prelude/trait.CuMonitor.html b/cu29/prelude/trait.CuMonitor.html
index f41c71792..983de1498 100644
--- a/cu29/prelude/trait.CuMonitor.html
+++ b/cu29/prelude/trait.CuMonitor.html
@@ -1,4 +1,4 @@
-CuMonitor in cu29::prelude - Rust

Trait CuMonitor

Source
pub trait CuMonitor: Sized {
+CuMonitor in cu29::prelude - Rust

Trait CuMonitor

Source
pub trait CuMonitor: Sized {
     // Required methods
     fn new(
         config: &CuConfig,
diff --git a/cu29/prelude/trait.CuMsgPack.html b/cu29/prelude/trait.CuMsgPack.html
index a5f372c3e..68c81eb2f 100644
--- a/cu29/prelude/trait.CuMsgPack.html
+++ b/cu29/prelude/trait.CuMsgPack.html
@@ -1,4 +1,4 @@
-CuMsgPack in cu29::prelude - Rust

Trait CuMsgPack

Source
pub trait CuMsgPack<'cl> { }

Implementations on Foreign Types§

Source§

impl CuMsgPack<'_> for ()

Source§

impl<'cl, T1, T2> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>)
where +CuMsgPack in cu29::prelude - Rust

Trait CuMsgPack

Source
pub trait CuMsgPack<'cl> { }

Implementations on Foreign Types§

Source§

impl CuMsgPack<'_> for ()

Source§

impl<'cl, T1, T2> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>)
where T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl,

Source§

impl<'cl, T1, T2, T3> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>, &'cl CuMsg<T3>)
where T1: CuMsgPayload + 'cl, diff --git a/cu29/prelude/trait.CuMsgPayload.html b/cu29/prelude/trait.CuMsgPayload.html index 196c267bd..e00f4f2e0 100644 --- a/cu29/prelude/trait.CuMsgPayload.html +++ b/cu29/prelude/trait.CuMsgPayload.html @@ -1,4 +1,4 @@ -CuMsgPayload in cu29::prelude - Rust

Trait CuMsgPayload

Source
pub trait CuMsgPayload:
+CuMsgPayload in cu29::prelude - Rust

Trait CuMsgPayload

Source
pub trait CuMsgPayload:
     Sized
     + Default
     + Debug
diff --git a/cu29/prelude/trait.CuPool.html b/cu29/prelude/trait.CuPool.html
index a6e17b378..a8d5913b6 100644
--- a/cu29/prelude/trait.CuPool.html
+++ b/cu29/prelude/trait.CuPool.html
@@ -1,4 +1,4 @@
-CuPool in cu29::prelude - Rust

Trait CuPool

Source
pub trait CuPool<T>: PoolMonitor
where +CuPool in cu29::prelude - Rust

Trait CuPool

Source
pub trait CuPool<T>: PoolMonitor
where T: ArrayLike,
{ // Required methods fn acquire(&self) -> Option<CuHandle<T>>; diff --git a/cu29/prelude/trait.CuSinkTask.html b/cu29/prelude/trait.CuSinkTask.html index 5fd769068..bdaad9fba 100644 --- a/cu29/prelude/trait.CuSinkTask.html +++ b/cu29/prelude/trait.CuSinkTask.html @@ -1,4 +1,4 @@ -CuSinkTask in cu29::prelude - Rust

Trait CuSinkTask

Source
pub trait CuSinkTask<'cl>: Freezable {
+CuSinkTask in cu29::prelude - Rust

Trait CuSinkTask

Source
pub trait CuSinkTask<'cl>: Freezable {
     type Input: CuMsgPack<'cl>;
 
     // Required methods
diff --git a/cu29/prelude/trait.CuSrcTask.html b/cu29/prelude/trait.CuSrcTask.html
index 7d7469ff2..8950a22ac 100644
--- a/cu29/prelude/trait.CuSrcTask.html
+++ b/cu29/prelude/trait.CuSrcTask.html
@@ -1,4 +1,4 @@
-CuSrcTask in cu29::prelude - Rust

Trait CuSrcTask

Source
pub trait CuSrcTask<'cl>: Freezable {
+CuSrcTask in cu29::prelude - Rust

Trait CuSrcTask

Source
pub trait CuSrcTask<'cl>: Freezable {
     type Output: CuMsgPack<'cl>;
 
     // Required methods
diff --git a/cu29/prelude/trait.CuTask.html b/cu29/prelude/trait.CuTask.html
index 303135f17..62320a7c8 100644
--- a/cu29/prelude/trait.CuTask.html
+++ b/cu29/prelude/trait.CuTask.html
@@ -1,4 +1,4 @@
-CuTask in cu29::prelude - Rust

Trait CuTask

Source
pub trait CuTask<'cl>: Freezable {
+CuTask in cu29::prelude - Rust

Trait CuTask

Source
pub trait CuTask<'cl>: Freezable {
     type Input: CuMsgPack<'cl>;
     type Output: CuMsgPack<'cl>;
 
diff --git a/cu29/prelude/trait.DeviceCuPool.html b/cu29/prelude/trait.DeviceCuPool.html
index 35ded958e..225e00a05 100644
--- a/cu29/prelude/trait.DeviceCuPool.html
+++ b/cu29/prelude/trait.DeviceCuPool.html
@@ -1,4 +1,4 @@
-DeviceCuPool in cu29::prelude - Rust

Trait DeviceCuPool

Source
pub trait DeviceCuPool<T>: CuPool<T>
where +DeviceCuPool in cu29::prelude - Rust

Trait DeviceCuPool

Source
pub trait DeviceCuPool<T>: CuPool<T>
where T: ArrayLike,
{ // Required method fn copy_to_host_pool<O>( diff --git a/cu29/prelude/trait.ElementType.html b/cu29/prelude/trait.ElementType.html index afdf40f00..fe03a23d0 100644 --- a/cu29/prelude/trait.ElementType.html +++ b/cu29/prelude/trait.ElementType.html @@ -1,4 +1,4 @@ -ElementType in cu29::prelude - Rust

Trait ElementType

Source
pub trait ElementType:
+ElementType in cu29::prelude - Rust

Trait ElementType

Source
pub trait ElementType:
     Sized
     + Default
     + Copy
diff --git a/cu29/prelude/trait.Freezable.html b/cu29/prelude/trait.Freezable.html
index 3274d4fba..04979eb01 100644
--- a/cu29/prelude/trait.Freezable.html
+++ b/cu29/prelude/trait.Freezable.html
@@ -1,4 +1,4 @@
-Freezable in cu29::prelude - Rust

Trait Freezable

Source
pub trait Freezable {
+Freezable in cu29::prelude - Rust

Trait Freezable

Source
pub trait Freezable {
     // Provided methods
     fn freeze<E>(&self, encoder: &mut E) -> Result<(), EncodeError>
        where E: Encoder { ... }
diff --git a/cu29/prelude/trait.PoolMonitor.html b/cu29/prelude/trait.PoolMonitor.html
index ffcf144f0..bdc5b32aa 100644
--- a/cu29/prelude/trait.PoolMonitor.html
+++ b/cu29/prelude/trait.PoolMonitor.html
@@ -1,4 +1,4 @@
-PoolMonitor in cu29::prelude - Rust

Trait PoolMonitor

Source
pub trait PoolMonitor: Send + Sync {
+PoolMonitor in cu29::prelude - Rust

Trait PoolMonitor

Source
pub trait PoolMonitor: Send + Sync {
     // Required methods
     fn id(&self) -> ArrayString<64>;
     fn space_left(&self) -> usize;
diff --git a/cu29/prelude/trait.WriteStream.html b/cu29/prelude/trait.WriteStream.html
index e45db80a6..331c210d6 100644
--- a/cu29/prelude/trait.WriteStream.html
+++ b/cu29/prelude/trait.WriteStream.html
@@ -1,4 +1,4 @@
-WriteStream in cu29::prelude - Rust

Trait WriteStream

pub trait WriteStream<E>:
+WriteStream in cu29::prelude - Rust

Trait WriteStream

pub trait WriteStream<E>:
     Sync
     + Send
     + Debug
where diff --git a/cu29/prelude/type.AscIter.html b/cu29/prelude/type.AscIter.html index 9fb93d72e..2fb5be2b2 100644 --- a/cu29/prelude/type.AscIter.html +++ b/cu29/prelude/type.AscIter.html @@ -1 +1 @@ -AscIter in cu29::prelude - Rust

Type Alias AscIter

Source
pub type AscIter<'a, T> = Chain<Iter<'a, T>, Iter<'a, T>>;

Aliased Type§

struct AscIter<'a, T> { /* private fields */ }
\ No newline at end of file +AscIter in cu29::prelude - Rust

Type Alias AscIter

Source
pub type AscIter<'a, T> = Chain<Iter<'a, T>, Iter<'a, T>>;

Aliased Type§

struct AscIter<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/prelude/type.AscIterMut.html b/cu29/prelude/type.AscIterMut.html index 258dfd7a8..095ae8fea 100644 --- a/cu29/prelude/type.AscIterMut.html +++ b/cu29/prelude/type.AscIterMut.html @@ -1 +1 @@ -AscIterMut in cu29::prelude - Rust

Type Alias AscIterMut

Source
pub type AscIterMut<'a, T> = Chain<IterMut<'a, T>, IterMut<'a, T>>;

Aliased Type§

struct AscIterMut<'a, T> { /* private fields */ }
\ No newline at end of file +AscIterMut in cu29::prelude - Rust

Type Alias AscIterMut

Source
pub type AscIterMut<'a, T> = Chain<IterMut<'a, T>, IterMut<'a, T>>;

Aliased Type§

struct AscIterMut<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/prelude/type.CuResult.html b/cu29/prelude/type.CuResult.html index 5fc9efd49..be6564b1e 100644 --- a/cu29/prelude/type.CuResult.html +++ b/cu29/prelude/type.CuResult.html @@ -1,4 +1,4 @@ -CuResult in cu29::prelude - Rust

Type Alias CuResult

pub type CuResult<T> = Result<T, CuError>;

Aliased Type§

enum CuResult<T> {
+CuResult in cu29::prelude - Rust

Type Alias CuResult

pub type CuResult<T> = Result<T, CuError>;

Aliased Type§

enum CuResult<T> {
     Ok(T),
     Err(CuError),
 }

Variants§

§1.0.0

Ok(T)

Contains the success value

diff --git a/cu29/prelude/type.CuTime.html b/cu29/prelude/type.CuTime.html index 936b4265d..c7b2b0603 100644 --- a/cu29/prelude/type.CuTime.html +++ b/cu29/prelude/type.CuTime.html @@ -1,2 +1,2 @@ -CuTime in cu29::prelude - Rust

Type Alias CuTime

pub type CuTime = CuDuration;
Expand description

A robot time is just a duration from a fixed point in time.

+CuTime in cu29::prelude - Rust

Type Alias CuTime

pub type CuTime = CuDuration;
Expand description

A robot time is just a duration from a fixed point in time.

Aliased Type§

struct CuTime(pub u64);

Fields§

§0: u64
\ No newline at end of file diff --git a/cu29/prelude/type.Iter.html b/cu29/prelude/type.Iter.html index 09c34d7ff..9935d54dd 100644 --- a/cu29/prelude/type.Iter.html +++ b/cu29/prelude/type.Iter.html @@ -1 +1 @@ -Iter in cu29::prelude - Rust

Type Alias Iter

Source
pub type Iter<'a, T> = Chain<Rev<Iter<'a, T>>, Rev<Iter<'a, T>>>;

Aliased Type§

struct Iter<'a, T> { /* private fields */ }
\ No newline at end of file +Iter in cu29::prelude - Rust

Type Alias Iter

Source
pub type Iter<'a, T> = Chain<Rev<Iter<'a, T>>, Rev<Iter<'a, T>>>;

Aliased Type§

struct Iter<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/prelude/type.IterMut.html b/cu29/prelude/type.IterMut.html index d199b71dd..c82189fcf 100644 --- a/cu29/prelude/type.IterMut.html +++ b/cu29/prelude/type.IterMut.html @@ -1 +1 @@ -IterMut in cu29::prelude - Rust

Type Alias IterMut

Source
pub type IterMut<'a, T> = Chain<Rev<IterMut<'a, T>>, Rev<IterMut<'a, T>>>;

Aliased Type§

struct IterMut<'a, T> { /* private fields */ }
\ No newline at end of file +IterMut in cu29::prelude - Rust

Type Alias IterMut

Source
pub type IterMut<'a, T> = Chain<Rev<IterMut<'a, T>>, Rev<IterMut<'a, T>>>;

Aliased Type§

struct IterMut<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29/prelude/type.NodeId.html b/cu29/prelude/type.NodeId.html index 64d295d58..e69b30727 100644 --- a/cu29/prelude/type.NodeId.html +++ b/cu29/prelude/type.NodeId.html @@ -1,3 +1,3 @@ -NodeId in cu29::prelude - Rust

Type Alias NodeId

Source
pub type NodeId = u32;
Expand description

NodeId is the unique identifier of a node in the configuration graph for petgraph +NodeId in cu29::prelude - Rust

Type Alias NodeId

Source
pub type NodeId = u32;
Expand description

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

\ No newline at end of file diff --git a/cu29/simulation/enum.CuTaskCallbackState.html b/cu29/simulation/enum.CuTaskCallbackState.html index d23c21ee4..73fbafeb6 100644 --- a/cu29/simulation/enum.CuTaskCallbackState.html +++ b/cu29/simulation/enum.CuTaskCallbackState.html @@ -1,4 +1,4 @@ -CuTaskCallbackState in cu29::simulation - Rust

Enum CuTaskCallbackState

Source
pub enum CuTaskCallbackState<'cl, I, O>
where +CuTaskCallbackState in cu29::simulation - Rust

Enum CuTaskCallbackState

Source
pub enum CuTaskCallbackState<'cl, I, O>
where I: CuMsgPack<'cl>, O: CuMsgPack<'cl>,
{ New(Option<ComponentConfig>), diff --git a/cu29/simulation/enum.SimOverride.html b/cu29/simulation/enum.SimOverride.html index 47222c8f2..6e0bea9f7 100644 --- a/cu29/simulation/enum.SimOverride.html +++ b/cu29/simulation/enum.SimOverride.html @@ -1,4 +1,4 @@ -SimOverride in cu29::simulation - Rust

Enum SimOverride

Source
pub enum SimOverride {
+SimOverride in cu29::simulation - Rust

Enum SimOverride

Source
pub enum SimOverride {
     ExecutedBySim,
     ExecuteByRuntime,
     Errored(String),
diff --git a/cu29/simulation/index.html b/cu29/simulation/index.html
index ffc8a75d4..d3f0cf1eb 100644
--- a/cu29/simulation/index.html
+++ b/cu29/simulation/index.html
@@ -1,4 +1,4 @@
-cu29::simulation - Rust

Module simulation

Source
Expand description

§cu29::simulation Module

+cu29::simulation - Rust

Module simulation

Source
Expand description

§cu29::simulation Module

The cu29::simulation module provides an interface to simulate tasks in Copper-based systems. It offers structures, traits, and enums that enable hooking into the lifecycle of tasks, adapting their behavior, and integrating them with simulated hardware environments.

diff --git a/cu29/simulation/struct.CuSimSinkTask.html b/cu29/simulation/struct.CuSimSinkTask.html index 3871da3ac..15f6d5eea 100644 --- a/cu29/simulation/struct.CuSimSinkTask.html +++ b/cu29/simulation/struct.CuSimSinkTask.html @@ -1,4 +1,4 @@ -CuSimSinkTask in cu29::simulation - Rust

Struct CuSimSinkTask

Source
pub struct CuSimSinkTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a sink task for the simulations. +CuSimSinkTask in cu29::simulation - Rust

Struct CuSimSinkTask

Source
pub struct CuSimSinkTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a sink task for the simulations. It basically does nothing in place of a real driver so it won’t try to initialize any hardware.

Trait Implementations§

Source§

impl<'cl, T> CuSinkTask<'cl> for CuSimSinkTask<T>
where T: CuMsgPayload + 'cl,

Source§

type Input = &'cl CuMsg<T>

Source§

fn new(_config: Option<&ComponentConfig>) -> Result<CuSimSinkTask<T>, CuError>
where diff --git a/cu29/simulation/struct.CuSimSrcTask.html b/cu29/simulation/struct.CuSimSrcTask.html index d3460e8d9..f4c8a54b7 100644 --- a/cu29/simulation/struct.CuSimSrcTask.html +++ b/cu29/simulation/struct.CuSimSrcTask.html @@ -1,4 +1,4 @@ -CuSimSrcTask in cu29::simulation - Rust

Struct CuSimSrcTask

Source
pub struct CuSimSrcTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a source task for the simulations. +CuSimSrcTask in cu29::simulation - Rust

Struct CuSimSrcTask

Source
pub struct CuSimSrcTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a source task for the simulations. It basically does nothing in place of a real driver so it won’t try to initialize any hardware.

Trait Implementations§

Source§

impl<'cl, T> CuSrcTask<'cl> for CuSimSrcTask<T>
where T: CuMsgPayload + 'cl,

Source§

type Output = &'cl mut CuMsg<T>

Source§

fn new(_config: Option<&ComponentConfig>) -> Result<CuSimSrcTask<T>, CuError>
where diff --git a/cu29/struct.CuError.html b/cu29/struct.CuError.html index be2531fc0..f6e21a845 100644 --- a/cu29/struct.CuError.html +++ b/cu29/struct.CuError.html @@ -1,4 +1,4 @@ -CuError in cu29 - Rust

Struct CuError

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

Common copper Error type.

+CuError in cu29 - Rust

Struct CuError

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

Common copper Error type.

Implementations§

§

impl CuError

pub fn new_with_cause(message: &str, cause: impl Error) -> CuError

pub fn add_cause(self, context: &str) -> CuError

Trait Implementations§

§

impl Clone for CuError

§

fn clone(&self) -> CuError

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
§

impl Debug for CuError

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for CuError

§

fn deserialize<__D>( __deserializer: __D, ) -> Result<CuError, <__D as Deserializer<'de>>::Error>
where diff --git a/cu29/trait.CopperListTuple.html b/cu29/trait.CopperListTuple.html index e2a46a46d..e86400959 100644 --- a/cu29/trait.CopperListTuple.html +++ b/cu29/trait.CopperListTuple.html @@ -1,4 +1,4 @@ -CopperListTuple in cu29 - Rust

Trait CopperListTuple

pub trait CopperListTuple:
+CopperListTuple in cu29 - Rust

Trait CopperListTuple

pub trait CopperListTuple:
     Sized
     + Encode
     + Decode
diff --git a/cu29/trait.WriteStream.html b/cu29/trait.WriteStream.html
index c66e9826f..13d0b297b 100644
--- a/cu29/trait.WriteStream.html
+++ b/cu29/trait.WriteStream.html
@@ -1,4 +1,4 @@
-WriteStream in cu29 - Rust

Trait WriteStream

pub trait WriteStream<E>:
+WriteStream in cu29 - Rust

Trait WriteStream

pub trait WriteStream<E>:
     Sync
     + Send
     + Debug
where diff --git a/cu29/type.CuResult.html b/cu29/type.CuResult.html index aac7faa58..827c5930b 100644 --- a/cu29/type.CuResult.html +++ b/cu29/type.CuResult.html @@ -1,4 +1,4 @@ -CuResult in cu29 - Rust

Type Alias CuResult

pub type CuResult<T> = Result<T, CuError>;

Aliased Type§

enum CuResult<T> {
+CuResult in cu29 - Rust

Type Alias CuResult

pub type CuResult<T> = Result<T, CuError>;

Aliased Type§

enum CuResult<T> {
     Ok(T),
     Err(CuError),
 }

Variants§

§1.0.0

Ok(T)

Contains the success value

diff --git a/cu29_clock/all.html b/cu29_clock/all.html index 78eed579d..f536d9e67 100644 --- a/cu29_clock/all.html +++ b/cu29_clock/all.html @@ -1 +1 @@ -List of all items in this crate
\ No newline at end of file +List of all items in this crate
\ No newline at end of file diff --git a/cu29_clock/enum.Tov.html b/cu29_clock/enum.Tov.html index 257fc2bfc..469b71a4a 100644 --- a/cu29_clock/enum.Tov.html +++ b/cu29_clock/enum.Tov.html @@ -1,4 +1,4 @@ -Tov in cu29_clock - Rust

Enum Tov

Source
pub enum Tov {
+Tov in cu29_clock - Rust

Enum Tov

Source
pub enum Tov {
     None,
     Time(CuTime),
     Range(CuTimeRange),
diff --git a/cu29_clock/index.html b/cu29_clock/index.html
index 6cb3fc5b9..5d65b3bb2 100644
--- a/cu29_clock/index.html
+++ b/cu29_clock/index.html
@@ -1,4 +1,4 @@
-cu29_clock - Rust

Crate cu29_clock

Source

Structs§

CuDuration
For Robot times, the underlying type is a u64 representing nanoseconds. +cu29_clock - Rust

Crate cu29_clock

Source

Structs§

CuDuration
For Robot times, the underlying type is a u64 representing nanoseconds. It is always positive to simplify the reasoning on the user side.
CuTimeRange
Represents a time range.
Instant
A point-in-time wall-clock measurement.
OptionCuTime
Homebrewed Option<CuDuration> to avoid using 128bits just to represent an Option.
PartialCuTimeRange
Represents a time range with possible undefined start or end or both.
RobotClock
A running Robot clock. The clock is a monotonic clock that starts at an arbitrary reference time. 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.

Enums§

Tov
The time of validity of a message can be more than one time but can be a time range of Tovs. diff --git a/cu29_clock/struct.CuDuration.html b/cu29_clock/struct.CuDuration.html index bec2e29d4..c783be2eb 100644 --- a/cu29_clock/struct.CuDuration.html +++ b/cu29_clock/struct.CuDuration.html @@ -1,4 +1,4 @@ -CuDuration in cu29_clock - Rust

Struct CuDuration

Source
pub struct CuDuration(pub u64);
Expand description

For Robot times, the underlying type is a u64 representing nanoseconds. +CuDuration in cu29_clock - Rust

Struct CuDuration

Source
pub struct CuDuration(pub u64);
Expand description

For Robot times, the underlying type is a u64 representing nanoseconds. It is always positive to simplify the reasoning on the user side.

Tuple Fields§

§0: u64

Implementations§

Source§

impl CuDuration

Source

pub const MIN: CuDuration

Source

pub const MAX: CuDuration

Source

pub fn max(&self, p0: CuDuration) -> CuDuration

Source

pub fn min(&self, p0: CuDuration) -> CuDuration

Source

pub fn as_nanos(&self) -> u64

Trait Implementations§

Source§

impl Add for CuDuration

Source§

type Output = CuDuration

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Self) -> Self::Output

Performs the + operation. Read more
Source§

impl AddAssign for CuDuration

Source§

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more
Source§

impl<'de> BorrowDecode<'de> for CuDuration

Source§

fn borrow_decode<D: BorrowDecoder<'de>>( decoder: &mut D, diff --git a/cu29_clock/struct.CuTimeRange.html b/cu29_clock/struct.CuTimeRange.html index 413b6e5d8..6e4c95d80 100644 --- a/cu29_clock/struct.CuTimeRange.html +++ b/cu29_clock/struct.CuTimeRange.html @@ -1,4 +1,4 @@ -CuTimeRange in cu29_clock - Rust

Struct CuTimeRange

Source
pub struct CuTimeRange {
+CuTimeRange in cu29_clock - Rust

Struct CuTimeRange

Source
pub struct CuTimeRange {
     pub start: CuTime,
     pub end: CuTime,
 }
Expand description

Represents a time range.

diff --git a/cu29_clock/struct.Instant.html b/cu29_clock/struct.Instant.html index 49cab9a04..8bf684029 100644 --- a/cu29_clock/struct.Instant.html +++ b/cu29_clock/struct.Instant.html @@ -1,4 +1,4 @@ -Instant in cu29_clock - Rust

Struct Instant

pub struct Instant(/* private fields */);
Expand description

A point-in-time wall-clock measurement.

+Instant in cu29_clock - Rust

Struct Instant

pub struct Instant(/* private fields */);
Expand description

A point-in-time wall-clock measurement.

Mimics most of the functionality of std::time::Instant but provides an additional method for using the “recent time” feature of quanta.

§Monotonicity

diff --git a/cu29_clock/struct.OptionCuTime.html b/cu29_clock/struct.OptionCuTime.html index fc5fbf880..de5a6e9a1 100644 --- a/cu29_clock/struct.OptionCuTime.html +++ b/cu29_clock/struct.OptionCuTime.html @@ -1,4 +1,4 @@ -OptionCuTime in cu29_clock - Rust

Struct OptionCuTime

Source
pub struct OptionCuTime(/* private fields */);
Expand description

Homebrewed Option<CuDuration> to avoid using 128bits just to represent an Option.

+OptionCuTime in cu29_clock - Rust

Struct OptionCuTime

Source
pub struct OptionCuTime(/* private fields */);
Expand description

Homebrewed Option<CuDuration> to avoid using 128bits just to represent an Option.

Implementations§

Source§

impl OptionCuTime

Source

pub fn is_none(&self) -> bool

Source

pub fn none() -> Self

Source

pub fn unwrap(self) -> CuTime

Trait Implementations§

Source§

impl<'__de> BorrowDecode<'__de> for OptionCuTime

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 OptionCuTime

Source§

fn clone(&self) -> OptionCuTime

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 OptionCuTime

Source§

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

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

impl Decode for OptionCuTime

Source§

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

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

impl Default for OptionCuTime

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for OptionCuTime

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where diff --git a/cu29_clock/struct.PartialCuTimeRange.html b/cu29_clock/struct.PartialCuTimeRange.html index 82fe48e75..86762ea75 100644 --- a/cu29_clock/struct.PartialCuTimeRange.html +++ b/cu29_clock/struct.PartialCuTimeRange.html @@ -1,4 +1,4 @@ -PartialCuTimeRange in cu29_clock - Rust

Struct PartialCuTimeRange

Source
pub struct PartialCuTimeRange {
+PartialCuTimeRange in cu29_clock - Rust

Struct PartialCuTimeRange

Source
pub struct PartialCuTimeRange {
     pub start: OptionCuTime,
     pub end: OptionCuTime,
 }
Expand description

Represents a time range with possible undefined start or end or both.

diff --git a/cu29_clock/struct.RobotClock.html b/cu29_clock/struct.RobotClock.html index e66d3b4de..8d96cdd25 100644 --- a/cu29_clock/struct.RobotClock.html +++ b/cu29_clock/struct.RobotClock.html @@ -1,4 +1,4 @@ -RobotClock in cu29_clock - Rust

Struct RobotClock

Source
pub struct RobotClock { /* private fields */ }
Expand description

A running Robot clock. +RobotClock in cu29_clock - Rust

Struct RobotClock

Source
pub struct RobotClock { /* private fields */ }
Expand description

A running Robot clock. The clock is a monotonic clock that starts at an arbitrary reference time. It is clone resilient, ie a clone will be the same clock, even when mocked.

Implementations§

Source§

impl RobotClock

Source

pub fn new() -> Self

Creates a RobotClock using now as its reference time. diff --git a/cu29_clock/struct.RobotClockMock.html b/cu29_clock/struct.RobotClockMock.html index 499e0f871..68c81741f 100644 --- a/cu29_clock/struct.RobotClockMock.html +++ b/cu29_clock/struct.RobotClockMock.html @@ -1,4 +1,4 @@ -RobotClockMock in cu29_clock - Rust

Struct RobotClockMock

Source
pub struct RobotClockMock(/* private fields */);
Expand description

A mock clock that can be controlled by the user.

+RobotClockMock in cu29_clock - Rust

Struct RobotClockMock

Source
pub struct RobotClockMock(/* private fields */);
Expand description

A mock clock that can be controlled by the user.

Implementations§

Source§

impl RobotClockMock

Source

pub fn increment(&self, amount: Duration)

Source

pub fn decrement(&self, amount: Duration)

Decrements the time by the given amount. Be careful this brakes the monotonicity of the clock.

Source

pub fn value(&self) -> u64

Gets the current value of time.

diff --git a/cu29_clock/trait.ClockProvider.html b/cu29_clock/trait.ClockProvider.html index 8d5baeda3..bd7ea8d34 100644 --- a/cu29_clock/trait.ClockProvider.html +++ b/cu29_clock/trait.ClockProvider.html @@ -1,4 +1,4 @@ -ClockProvider in cu29_clock - Rust

Trait ClockProvider

Source
pub trait ClockProvider {
+ClockProvider in cu29_clock - Rust

Trait ClockProvider

Source
pub trait ClockProvider {
     // Required method
     fn get_clock(&self) -> RobotClock;
 }
Expand description

A trait to provide a clock to the runtime.

diff --git a/cu29_clock/type.CuTime.html b/cu29_clock/type.CuTime.html index 147ec3d31..9e6001ad1 100644 --- a/cu29_clock/type.CuTime.html +++ b/cu29_clock/type.CuTime.html @@ -1,2 +1,2 @@ -CuTime in cu29_clock - Rust

Type Alias CuTime

Source
pub type CuTime = CuDuration;
Expand description

A robot time is just a duration from a fixed point in time.

+CuTime in cu29_clock - Rust

Type Alias CuTime

Source
pub type CuTime = CuDuration;
Expand description

A robot time is just a duration from a fixed point in time.

Aliased Type§

struct CuTime(pub u64);

Fields§

§0: u64
\ No newline at end of file diff --git a/cu29_derive/all.html b/cu29_derive/all.html index 1fb57ddfa..d59c21355 100644 --- a/cu29_derive/all.html +++ b/cu29_derive/all.html @@ -1 +1 @@ -List of all items in this crate

List of all items

Macros

Attribute Macros

\ No newline at end of file +List of all items in this crate

List of all items

Macros

Attribute Macros

\ No newline at end of file diff --git a/cu29_derive/attr.copper_runtime.html b/cu29_derive/attr.copper_runtime.html index 26f5bc57c..97bc7b9c7 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

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. +copper_runtime in cu29_derive - Rust

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 91c28812a..3808f248c 100644 --- a/cu29_derive/index.html +++ b/cu29_derive/index.html @@ -1,4 +1,4 @@ -cu29_derive - Rust

Crate cu29_derive

Source

Macros§

gen_cumsgs
Generates the CopperList content type from a config. +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 omitted, it is set to false. diff --git a/cu29_derive/macro.gen_cumsgs.html b/cu29_derive/macro.gen_cumsgs.html index edb896ad3..4e6ccc904 100644 --- a/cu29_derive/macro.gen_cumsgs.html +++ b/cu29_derive/macro.gen_cumsgs.html @@ -1,4 +1,4 @@ -gen_cumsgs in cu29_derive - Rust

Macro gen_cumsgs

Source
gen_cumsgs!() { /* proc-macro */ }
Expand description

Generates the CopperList content type from a config. +gen_cumsgs in cu29_derive - Rust

Macro gen_cumsgs

Source
gen_cumsgs!() { /* proc-macro */ }
Expand description

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:

\ No newline at end of file diff --git a/cu29_export/all.html b/cu29_export/all.html index 7cd3a5fd0..9236cc8c1 100644 --- a/cu29_export/all.html +++ b/cu29_export/all.html @@ -1 +1 @@ -List of all items in this crate
\ No newline at end of file +List of all items in this crate
\ No newline at end of file diff --git a/cu29_export/enum.Command.html b/cu29_export/enum.Command.html index fe80ac039..32f747b43 100644 --- a/cu29_export/enum.Command.html +++ b/cu29_export/enum.Command.html @@ -1,4 +1,4 @@ -Command in cu29_export - Rust

Enum Command

Source
pub enum Command {
+Command in cu29_export - Rust

Enum Command

Source
pub enum Command {
     ExtractLog {
         log_index: PathBuf,
     },
diff --git a/cu29_export/enum.ExportFormat.html b/cu29_export/enum.ExportFormat.html
index 9910611ee..025e88d0a 100644
--- a/cu29_export/enum.ExportFormat.html
+++ b/cu29_export/enum.ExportFormat.html
@@ -1,4 +1,4 @@
-ExportFormat in cu29_export - Rust

Enum ExportFormat

Source
pub enum ExportFormat {
+ExportFormat in cu29_export - Rust

Enum ExportFormat

Source
pub enum ExportFormat {
     Json,
     Csv,
 }

Variants§

§

Json

§

Csv

Trait Implementations§

Source§

impl Clone for ExportFormat

Source§

fn clone(&self) -> ExportFormat

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 Display for ExportFormat

Source§

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

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

impl Ord for ExportFormat

Source§

fn cmp(&self, other: &ExportFormat) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where diff --git a/cu29_export/fn.copperlists_dump.html b/cu29_export/fn.copperlists_dump.html index 19327850e..69fe0e663 100644 --- a/cu29_export/fn.copperlists_dump.html +++ b/cu29_export/fn.copperlists_dump.html @@ -1,4 +1,4 @@ -copperlists_dump in cu29_export - Rust

Function copperlists_dump

Source
pub fn copperlists_dump<P: CopperListTuple>(
+copperlists_dump in cu29_export - Rust

Function copperlists_dump

Source
pub fn copperlists_dump<P: CopperListTuple>(
     src: impl Read,
 ) -> impl Iterator<Item = CopperList<P>>
Expand description

Extracts the copper lists from a binary representation. P is the Payload determined by the configuration of the application.

diff --git a/cu29_export/fn.run_cli.html b/cu29_export/fn.run_cli.html index e6c57b66a..eb472fbfd 100644 --- a/cu29_export/fn.run_cli.html +++ b/cu29_export/fn.run_cli.html @@ -1,4 +1,4 @@ -run_cli in cu29_export - Rust

Function run_cli

Source
pub fn run_cli<P>() -> CuResult<()>
where +run_cli in cu29_export - Rust

Function run_cli

Source
pub fn run_cli<P>() -> CuResult<()>
where P: CopperListTuple,
Expand description

This is a generator for a main function to build a log extractor. It depends on the specific type of the CopperList payload that is determined at compile time from the configuration.

\ No newline at end of file diff --git a/cu29_export/fn.textlog_dump.html b/cu29_export/fn.textlog_dump.html index 0765ea5ea..289a88152 100644 --- a/cu29_export/fn.textlog_dump.html +++ b/cu29_export/fn.textlog_dump.html @@ -1,4 +1,4 @@ -textlog_dump in cu29_export - Rust

Function textlog_dump

Source
pub fn textlog_dump(src: impl Read, index: &Path) -> CuResult<()>
Expand description

Full dump of the copper structured log from its binary representation. +textlog_dump in cu29_export - Rust

Function textlog_dump

Source
pub fn textlog_dump(src: impl Read, index: &Path) -> CuResult<()>
Expand description

Full dump of the copper structured log from its binary representation. This rebuilds a textual log. src: the source of the log data index: the path to the index file (containing the interned strings constructed at build time)

diff --git a/cu29_export/index.html b/cu29_export/index.html index 8b45d6776..d1068f6ea 100644 --- a/cu29_export/index.html +++ b/cu29_export/index.html @@ -1,4 +1,4 @@ -cu29_export - Rust

Crate cu29_export

Source

Structs§

LogReaderCli
This is a generator for a main function to build a log extractor.

Enums§

Command
ExportFormat

Functions§

copperlists_dump
Extracts the copper lists from a binary representation. +cu29_export - Rust

Crate cu29_export

Source

Structs§

LogReaderCli
This is a generator for a main function to build a log extractor.

Enums§

Command
ExportFormat

Functions§

copperlists_dump
Extracts the copper lists from a binary representation. P is the Payload determined by the configuration of the application.
run_cli
This is a generator for a main function to build a log extractor. It depends on the specific type of the CopperList payload that is determined at compile time from the configuration.
textlog_dump
Full dump of the copper structured log from its binary representation. This rebuilds a textual log. diff --git a/cu29_export/struct.LogReaderCli.html b/cu29_export/struct.LogReaderCli.html index 5ef38fd78..246bad24b 100644 --- a/cu29_export/struct.LogReaderCli.html +++ b/cu29_export/struct.LogReaderCli.html @@ -1,4 +1,4 @@ -LogReaderCli in cu29_export - Rust

Struct LogReaderCli

Source
pub struct LogReaderCli {
+LogReaderCli in cu29_export - Rust

Struct LogReaderCli

Source
pub struct LogReaderCli {
     pub unifiedlog_base: PathBuf,
     pub command: Command,
 }
Expand description

This is a generator for a main function to build a log extractor.

diff --git a/cu29_helpers/all.html b/cu29_helpers/all.html index f84d92c41..5a7423fca 100644 --- a/cu29_helpers/all.html +++ b/cu29_helpers/all.html @@ -1 +1 @@ -List of all items in this crate

List of all items

Functions

\ No newline at end of file +List of all items in this crate

List of all items

Functions

\ No newline at end of file diff --git a/cu29_helpers/fn.basic_copper_setup.html b/cu29_helpers/fn.basic_copper_setup.html index dd1002cce..f3df114c6 100644 --- a/cu29_helpers/fn.basic_copper_setup.html +++ b/cu29_helpers/fn.basic_copper_setup.html @@ -1,4 +1,4 @@ -basic_copper_setup in cu29_helpers - Rust

Function basic_copper_setup

Source
pub fn basic_copper_setup(
+basic_copper_setup in cu29_helpers - Rust

Function basic_copper_setup

Source
pub fn basic_copper_setup(
     unifiedlogger_output_base_name: &Path,
     slab_size: Option<usize>,
     _text_log: bool,
diff --git a/cu29_helpers/index.html b/cu29_helpers/index.html
index 6e028f926..b9b105cd0 100644
--- a/cu29_helpers/index.html
+++ b/cu29_helpers/index.html
@@ -1,2 +1,2 @@
-cu29_helpers - Rust

Crate cu29_helpers

Source

Functions§

basic_copper_setup
This is a basic setup for a copper application to get you started. +cu29_helpers - Rust

Crate cu29_helpers

Source

Functions§

basic_copper_setup
This is a basic setup for a copper application to get you started. Duplicate and customize as needed when your needs grow.
\ No newline at end of file diff --git a/cu29_intern_strs/all.html b/cu29_intern_strs/all.html index a38157c46..a41c17774 100644 --- a/cu29_intern_strs/all.html +++ b/cu29_intern_strs/all.html @@ -1 +1 @@ -List of all items in this crate

List of all items

Functions

\ No newline at end of file +List of all items in this crate

List of all items

Functions

\ No newline at end of file diff --git a/cu29_intern_strs/fn.read_interned_strings.html b/cu29_intern_strs/fn.read_interned_strings.html index f192d13cd..a5175331b 100644 --- a/cu29_intern_strs/fn.read_interned_strings.html +++ b/cu29_intern_strs/fn.read_interned_strings.html @@ -1,2 +1,2 @@ -read_interned_strings in cu29_intern_strs - Rust

Function read_interned_strings

Source
pub fn read_interned_strings(index: &Path) -> CuResult<Vec<String>>
Expand description

Rebuild the interned string index in memory.

+read_interned_strings in cu29_intern_strs - Rust

Function read_interned_strings

Source
pub fn read_interned_strings(index: &Path) -> CuResult<Vec<String>>
Expand description

Rebuild the interned string index in memory.

\ No newline at end of file diff --git a/cu29_intern_strs/index.html b/cu29_intern_strs/index.html index 372aad36c..a1d56468d 100644 --- a/cu29_intern_strs/index.html +++ b/cu29_intern_strs/index.html @@ -1 +1 @@ -cu29_intern_strs - Rust

Crate cu29_intern_strs

Source

Functions§

read_interned_strings
Rebuild the interned string index in memory.
\ No newline at end of file +cu29_intern_strs - Rust

Crate cu29_intern_strs

Source

Functions§

read_interned_strings
Rebuild the interned string index in memory.
\ No newline at end of file diff --git a/cu29_log/all.html b/cu29_log/all.html index 037979343..4cf1c7232 100644 --- a/cu29_log/all.html +++ b/cu29_log/all.html @@ -1 +1 @@ -List of all items in this crate
\ No newline at end of file +List of all items in this crate
\ No newline at end of file diff --git a/cu29_log/constant.ANONYMOUS.html b/cu29_log/constant.ANONYMOUS.html index 289757b20..e5154af0b 100644 --- a/cu29_log/constant.ANONYMOUS.html +++ b/cu29_log/constant.ANONYMOUS.html @@ -1 +1 @@ -ANONYMOUS in cu29_log - Rust

Constant ANONYMOUS

Source
pub const ANONYMOUS: u32 = 0;
\ No newline at end of file +ANONYMOUS in cu29_log - Rust

Constant ANONYMOUS

Source
pub const ANONYMOUS: u32 = 0;
\ No newline at end of file diff --git a/cu29_log/constant.MAX_LOG_PARAMS_ON_STACK.html b/cu29_log/constant.MAX_LOG_PARAMS_ON_STACK.html index 16e96c60c..3c74d3761 100644 --- a/cu29_log/constant.MAX_LOG_PARAMS_ON_STACK.html +++ b/cu29_log/constant.MAX_LOG_PARAMS_ON_STACK.html @@ -1 +1 @@ -MAX_LOG_PARAMS_ON_STACK in cu29_log - Rust

Constant MAX_LOG_PARAMS_ON_STACK

Source
pub const MAX_LOG_PARAMS_ON_STACK: usize = 10;
\ No newline at end of file +MAX_LOG_PARAMS_ON_STACK in cu29_log - Rust

Constant MAX_LOG_PARAMS_ON_STACK

Source
pub const MAX_LOG_PARAMS_ON_STACK: usize = 10;
\ No newline at end of file diff --git a/cu29_log/fn.default_log_index_dir.html b/cu29_log/fn.default_log_index_dir.html index 43817fc62..ba99fba9d 100644 --- a/cu29_log/fn.default_log_index_dir.html +++ b/cu29_log/fn.default_log_index_dir.html @@ -1,2 +1,2 @@ -default_log_index_dir in cu29_log - Rust

Function default_log_index_dir

Source
pub fn default_log_index_dir() -> PathBuf
Expand description

Convenience function to returns the default path for the log index directory.

+default_log_index_dir in cu29_log - Rust

Function default_log_index_dir

Source
pub fn default_log_index_dir() -> PathBuf
Expand description

Convenience function to returns the default path for the log index directory.

\ No newline at end of file diff --git a/cu29_log/fn.format_logline.html b/cu29_log/fn.format_logline.html index 6d4b05d1d..c70fad169 100644 --- a/cu29_log/fn.format_logline.html +++ b/cu29_log/fn.format_logline.html @@ -1,4 +1,4 @@ -format_logline in cu29_log - Rust

Function format_logline

Source
pub fn format_logline(
+format_logline in cu29_log - Rust

Function format_logline

Source
pub fn format_logline(
     time: CuTime,
     format_str: &str,
     params: &[String],
diff --git a/cu29_log/fn.rebuild_logline.html b/cu29_log/fn.rebuild_logline.html
index ec64ae359..eecf13ead 100644
--- a/cu29_log/fn.rebuild_logline.html
+++ b/cu29_log/fn.rebuild_logline.html
@@ -1,4 +1,4 @@
-rebuild_logline in cu29_log - Rust

Function rebuild_logline

Source
pub fn rebuild_logline(
+rebuild_logline in cu29_log - Rust

Function rebuild_logline

Source
pub fn rebuild_logline(
     all_interned_strings: &[String],
     entry: &CuLogEntry,
 ) -> CuResult<String>
Expand description

Rebuild a log line from the interned strings and the CuLogEntry. diff --git a/cu29_log/index.html b/cu29_log/index.html index 3a6c031af..4a7dfd0f3 100644 --- a/cu29_log/index.html +++ b/cu29_log/index.html @@ -1,2 +1,2 @@ -cu29_log - Rust

Crate cu29_log

Source

Structs§

CuLogEntry
This is the basic structure for a log entry in Copper.

Constants§

ANONYMOUS
MAX_LOG_PARAMS_ON_STACK

Functions§

default_log_index_dir
Convenience function to returns the default path for the log index directory.
format_logline
Text log line formatter.
rebuild_logline
Rebuild a log line from the interned strings and the CuLogEntry. +cu29_log - Rust

Crate cu29_log

Source

Structs§

CuLogEntry
This is the basic structure for a log entry in Copper.

Constants§

ANONYMOUS
MAX_LOG_PARAMS_ON_STACK

Functions§

default_log_index_dir
Convenience function to returns the default path for the log index directory.
format_logline
Text log line formatter.
rebuild_logline
Rebuild a log line from the interned strings and the CuLogEntry. This basically translates the world of copper logs to text logs.
\ No newline at end of file diff --git a/cu29_log/struct.CuLogEntry.html b/cu29_log/struct.CuLogEntry.html index db57a78f7..6d33693d8 100644 --- a/cu29_log/struct.CuLogEntry.html +++ b/cu29_log/struct.CuLogEntry.html @@ -1,4 +1,4 @@ -CuLogEntry in cu29_log - Rust

Struct CuLogEntry

Source
pub struct CuLogEntry {
+CuLogEntry in cu29_log - Rust

Struct CuLogEntry

Source
pub struct CuLogEntry {
     pub time: CuTime,
     pub msg_index: u32,
     pub paramname_indexes: SmallVec<[u32; 10]>,
diff --git a/cu29_log_derive/all.html b/cu29_log_derive/all.html
index da3420aa1..0d4ba7436 100644
--- a/cu29_log_derive/all.html
+++ b/cu29_log_derive/all.html
@@ -1 +1 @@
-List of all items in this crate

List of all items

Macros

\ No newline at end of file +List of all items in this crate

List of all items

Macros

\ No newline at end of file diff --git a/cu29_log_derive/index.html b/cu29_log_derive/index.html index 45ff8386c..b2b00d3ee 100644 --- a/cu29_log_derive/index.html +++ b/cu29_log_derive/index.html @@ -1,4 +1,4 @@ -cu29_log_derive - Rust

Crate cu29_log_derive

Source

Macros§

debug
This macro is used to log a message with parameters. +cu29_log_derive - Rust

Crate cu29_log_derive

Source

Macros§

debug
This macro is used to log a message with parameters. The first parameter is a string literal that represents the message to be logged. Only {} is supported as a placeholder for parameters. The rest of the parameters are the values to be logged. diff --git a/cu29_log_derive/macro.debug.html b/cu29_log_derive/macro.debug.html index ba0533065..77932f186 100644 --- a/cu29_log_derive/macro.debug.html +++ b/cu29_log_derive/macro.debug.html @@ -1,4 +1,4 @@ -debug in cu29_log_derive - Rust

Macro debug

Source
debug!() { /* proc-macro */ }
Expand description

This macro is used to log a message with parameters. +debug in cu29_log_derive - Rust

Macro debug

Source
debug!() { /* proc-macro */ }
Expand description

This macro is used to log a message with parameters. The first parameter is a string literal that represents the message to be logged. Only {} is supported as a placeholder for parameters. The rest of the parameters are the values to be logged. diff --git a/cu29_log_runtime/all.html b/cu29_log_runtime/all.html index 80acff357..878667432 100644 --- a/cu29_log_runtime/all.html +++ b/cu29_log_runtime/all.html @@ -1 +1 @@ -List of all items in this crate

\ No newline at end of file +List of all items in this crate
\ No newline at end of file diff --git a/cu29_log_runtime/fn.log.html b/cu29_log_runtime/fn.log.html index 1d74cc976..6a52a975a 100644 --- a/cu29_log_runtime/fn.log.html +++ b/cu29_log_runtime/fn.log.html @@ -1,3 +1,3 @@ -log in cu29_log_runtime - Rust

Function log

Source
pub fn log(entry: &mut CuLogEntry) -> CuResult<()>
Expand description

Function called from generated code to log data. +log in cu29_log_runtime - Rust

Function log

Source
pub fn log(entry: &mut CuLogEntry) -> CuResult<()>
Expand description

Function called from generated code to log data. It moves entry by design, it will be absorbed in the queue.

\ No newline at end of file diff --git a/cu29_log_runtime/fn.log_debug_mode.html b/cu29_log_runtime/fn.log_debug_mode.html index 6a3e60dcd..7f2e485c1 100644 --- a/cu29_log_runtime/fn.log_debug_mode.html +++ b/cu29_log_runtime/fn.log_debug_mode.html @@ -1,4 +1,4 @@ -log_debug_mode in cu29_log_runtime - Rust

Function log_debug_mode

Source
pub fn log_debug_mode(
+log_debug_mode in cu29_log_runtime - Rust

Function log_debug_mode

Source
pub fn log_debug_mode(
     entry: &mut CuLogEntry,
     format_str: &str,
     param_names: &[&str],
diff --git a/cu29_log_runtime/index.html b/cu29_log_runtime/index.html
index 63654799c..f6d9c2854 100644
--- a/cu29_log_runtime/index.html
+++ b/cu29_log_runtime/index.html
@@ -1,3 +1,3 @@
-cu29_log_runtime - Rust

Crate cu29_log_runtime

Source

Structs§

LoggerRuntime
The lifetime of this struct is the lifetime of the logger.
NullLog
OwningIoWriter
SimpleFileWriter
This allows this crate to be used outside of Copper (ie. decoupling it from the unifiedlog.

Statics§

EXTRA_TEXT_LOGGER

Functions§

log
Function called from generated code to log data. +cu29_log_runtime - Rust

Crate cu29_log_runtime

Source

Structs§

LoggerRuntime
The lifetime of this struct is the lifetime of the logger.
NullLog
OwningIoWriter
SimpleFileWriter
This allows this crate to be used outside of Copper (ie. decoupling it from the unifiedlog.

Statics§

EXTRA_TEXT_LOGGER

Functions§

log
Function called from generated code to log data. It moves entry by design, it will be absorbed in the queue.
log_debug_mode
This version of log is only compiled in debug mode This allows a normal logging framework to be bridged.
\ No newline at end of file diff --git a/cu29_log_runtime/static.EXTRA_TEXT_LOGGER.html b/cu29_log_runtime/static.EXTRA_TEXT_LOGGER.html index d01d7c6a2..162330bc4 100644 --- a/cu29_log_runtime/static.EXTRA_TEXT_LOGGER.html +++ b/cu29_log_runtime/static.EXTRA_TEXT_LOGGER.html @@ -1 +1 @@ -EXTRA_TEXT_LOGGER in cu29_log_runtime - Rust

Static EXTRA_TEXT_LOGGER

Source
pub static EXTRA_TEXT_LOGGER: RwLock<Option<Box<dyn Log + 'static>>>
\ No newline at end of file +EXTRA_TEXT_LOGGER in cu29_log_runtime - Rust

Static EXTRA_TEXT_LOGGER

Source
pub static EXTRA_TEXT_LOGGER: RwLock<Option<Box<dyn Log + 'static>>>
\ No newline at end of file diff --git a/cu29_log_runtime/struct.LoggerRuntime.html b/cu29_log_runtime/struct.LoggerRuntime.html index 9a28bae79..dd9c44f75 100644 --- a/cu29_log_runtime/struct.LoggerRuntime.html +++ b/cu29_log_runtime/struct.LoggerRuntime.html @@ -1,4 +1,4 @@ -LoggerRuntime in cu29_log_runtime - Rust

Struct LoggerRuntime

Source
pub struct LoggerRuntime {}
Expand description

The lifetime of this struct is the lifetime of the logger.

+LoggerRuntime in cu29_log_runtime - Rust

Struct LoggerRuntime

Source
pub struct LoggerRuntime {}
Expand description

The lifetime of this struct is the lifetime of the logger.

Implementations§

Source§

impl LoggerRuntime

Source

pub fn init( clock: RobotClock, destination: impl WriteStream<CuLogEntry> + 'static, diff --git a/cu29_log_runtime/struct.NullLog.html b/cu29_log_runtime/struct.NullLog.html index 5421a89ed..03caec252 100644 --- a/cu29_log_runtime/struct.NullLog.html +++ b/cu29_log_runtime/struct.NullLog.html @@ -1,4 +1,4 @@ -NullLog in cu29_log_runtime - Rust

Struct NullLog

Source
pub struct NullLog;

Trait Implementations§

Source§

impl Log for NullLog

Source§

fn enabled(&self, _metadata: &Metadata<'_>) -> bool

Determines if a log message with the specified metadata would be +NullLog in cu29_log_runtime - Rust

Struct NullLog

Source
pub struct NullLog;

Trait Implementations§

Source§

impl Log for NullLog

Source§

fn enabled(&self, _metadata: &Metadata<'_>) -> bool

Determines if a log message with the specified metadata would be logged. Read more
Source§

fn log(&self, _record: &Record<'_>)

Logs the Record. Read more
Source§

fn flush(&self)

Flushes any buffered records. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where diff --git a/cu29_log_runtime/struct.OwningIoWriter.html b/cu29_log_runtime/struct.OwningIoWriter.html index e20a013c9..9108c419b 100644 --- a/cu29_log_runtime/struct.OwningIoWriter.html +++ b/cu29_log_runtime/struct.OwningIoWriter.html @@ -1,4 +1,4 @@ -OwningIoWriter in cu29_log_runtime - Rust

Struct OwningIoWriter

Source
pub struct OwningIoWriter<W: Write> { /* private fields */ }

Implementations§

Source§

impl<W: Write> OwningIoWriter<W>

Source

pub fn new(writer: W) -> Self

Source

pub fn bytes_written(&self) -> usize

Source

pub fn flush(&mut self) -> Result<(), EncodeError>

Trait Implementations§

Source§

impl<W: Write> Writer for OwningIoWriter<W>

Source§

fn write(&mut self, bytes: &[u8]) -> Result<(), EncodeError>

Write bytes to the underlying writer. Exactly bytes.len() bytes must be written, or else an error should be returned.

Auto Trait Implementations§

§

impl<W> Freeze for OwningIoWriter<W>
where +OwningIoWriter in cu29_log_runtime - Rust

Struct OwningIoWriter

Source
pub struct OwningIoWriter<W: Write> { /* private fields */ }

Implementations§

Source§

impl<W: Write> OwningIoWriter<W>

Source

pub fn new(writer: W) -> Self

Source

pub fn bytes_written(&self) -> usize

Source

pub fn flush(&mut self) -> Result<(), EncodeError>

Trait Implementations§

Source§

impl<W: Write> Writer for OwningIoWriter<W>

Source§

fn write(&mut self, bytes: &[u8]) -> Result<(), EncodeError>

Write bytes to the underlying writer. Exactly bytes.len() bytes must be written, or else an error should be returned.

Auto Trait Implementations§

§

impl<W> Freeze for OwningIoWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for OwningIoWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for OwningIoWriter<W>
where W: Send,

§

impl<W> Sync for OwningIoWriter<W>
where diff --git a/cu29_log_runtime/struct.SimpleFileWriter.html b/cu29_log_runtime/struct.SimpleFileWriter.html index ab244f04f..1f55a54dd 100644 --- a/cu29_log_runtime/struct.SimpleFileWriter.html +++ b/cu29_log_runtime/struct.SimpleFileWriter.html @@ -1,4 +1,4 @@ -SimpleFileWriter in cu29_log_runtime - Rust

Struct SimpleFileWriter

Source
pub struct SimpleFileWriter { /* private fields */ }
Expand description

This allows this crate to be used outside of Copper (ie. decoupling it from the unifiedlog.

+SimpleFileWriter in cu29_log_runtime - Rust

Struct SimpleFileWriter

Source
pub struct SimpleFileWriter { /* private fields */ }
Expand description

This allows this crate to be used outside of Copper (ie. decoupling it from the unifiedlog.

Implementations§

Source§

impl SimpleFileWriter

Source

pub fn new(path: &PathBuf) -> CuResult<Self>

Trait Implementations§

Source§

impl Debug for SimpleFileWriter

Source§

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

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

impl WriteStream<CuLogEntry> for SimpleFileWriter

Source§

fn log(&mut self, obj: &CuLogEntry) -> CuResult<()>

Source§

fn flush(&mut self) -> CuResult<()>

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where diff --git a/cu29_rendercfg/all.html b/cu29_rendercfg/all.html index 719c0dfc5..930662417 100644 --- a/cu29_rendercfg/all.html +++ b/cu29_rendercfg/all.html @@ -1 +1 @@ -List of all items in this crate
\ No newline at end of file +List of all items in this crate
\ No newline at end of file diff --git a/cu29_rendercfg/config/fn.default_as_true.html b/cu29_rendercfg/config/fn.default_as_true.html index f142922c7..0f175c629 100644 --- a/cu29_rendercfg/config/fn.default_as_true.html +++ b/cu29_rendercfg/config/fn.default_as_true.html @@ -1 +1 @@ -default_as_true in cu29_rendercfg::config - Rust

Function default_as_true

Source
fn default_as_true() -> bool
\ No newline at end of file +default_as_true in cu29_rendercfg::config - Rust

Function default_as_true

Source
fn default_as_true() -> bool
\ No newline at end of file diff --git a/cu29_rendercfg/config/fn.read_configuration.html b/cu29_rendercfg/config/fn.read_configuration.html index 781adfd3e..7dba249e0 100644 --- a/cu29_rendercfg/config/fn.read_configuration.html +++ b/cu29_rendercfg/config/fn.read_configuration.html @@ -1,2 +1,2 @@ -read_configuration in cu29_rendercfg::config - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> CuResult<CuConfig>
Expand description

Read a copper configuration from a file.

+read_configuration in cu29_rendercfg::config - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> CuResult<CuConfig>
Expand description

Read a copper configuration from a file.

\ No newline at end of file diff --git a/cu29_rendercfg/config/fn.read_configuration_str.html b/cu29_rendercfg/config/fn.read_configuration_str.html index 44cb917e4..fd4b5775b 100644 --- a/cu29_rendercfg/config/fn.read_configuration_str.html +++ b/cu29_rendercfg/config/fn.read_configuration_str.html @@ -1,2 +1,2 @@ -read_configuration_str in cu29_rendercfg::config - Rust

Function read_configuration_str

Source
pub fn read_configuration_str(config_content: String) -> CuResult<CuConfig>
Expand description

Read a copper configuration from a String.

+read_configuration_str in cu29_rendercfg::config - Rust

Function read_configuration_str

Source
pub fn read_configuration_str(config_content: String) -> CuResult<CuConfig>
Expand description

Read a copper configuration from a String.

\ No newline at end of file diff --git a/cu29_rendercfg/config/index.html b/cu29_rendercfg/config/index.html index 8ef4a3172..27a76a85c 100644 --- a/cu29_rendercfg/config/index.html +++ b/cu29_rendercfg/config/index.html @@ -1,4 +1,4 @@ -cu29_rendercfg::config - Rust

Module config

Source
Expand description

This module defines the configuration of the copper runtime. +cu29_rendercfg::config - Rust

Module config

Source
Expand description

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

diff --git a/cu29_rendercfg/config/struct.Cnx.html b/cu29_rendercfg/config/struct.Cnx.html index e7af474e8..8d267b5dc 100644 --- a/cu29_rendercfg/config/struct.Cnx.html +++ b/cu29_rendercfg/config/struct.Cnx.html @@ -1,4 +1,4 @@ -Cnx in cu29_rendercfg::config - Rust

Struct Cnx

Source
pub struct Cnx {
+Cnx in cu29_rendercfg::config - Rust

Struct Cnx

Source
pub struct Cnx {
     src: String,
     dst: String,
     pub msg: String,
diff --git a/cu29_rendercfg/config/struct.ComponentConfig.html b/cu29_rendercfg/config/struct.ComponentConfig.html
index 111897184..074dabf6f 100644
--- a/cu29_rendercfg/config/struct.ComponentConfig.html
+++ b/cu29_rendercfg/config/struct.ComponentConfig.html
@@ -1,4 +1,4 @@
-ComponentConfig in cu29_rendercfg::config - Rust

Struct ComponentConfig

Source
pub struct ComponentConfig(pub HashMap<String, Value>);
Expand description

This is the configuration of a component (like a task config or a monitoring config):w +ComponentConfig in cu29_rendercfg::config - Rust

Struct ComponentConfig

Source
pub struct ComponentConfig(pub HashMap<String, Value>);
Expand description

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

Tuple Fields§

§0: HashMap<String, Value>

Implementations§

Source§

impl ComponentConfig

Source

pub fn new() -> Self

Source

pub fn get<T: From<Value>>(&self, key: &str) -> Option<T>

Source

pub fn set<T: Into<Value>>(&mut self, key: &str, value: T)

Trait Implementations§

Source§

impl Clone for ComponentConfig

Source§

fn clone(&self) -> ComponentConfig

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 ComponentConfig

Source§

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

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

impl Default for ComponentConfig

Source§

fn default() -> ComponentConfig

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

impl<'de> Deserialize<'de> for ComponentConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where diff --git a/cu29_rendercfg/config/struct.CuConfig.html b/cu29_rendercfg/config/struct.CuConfig.html index ff26848ed..9d720d616 100644 --- a/cu29_rendercfg/config/struct.CuConfig.html +++ b/cu29_rendercfg/config/struct.CuConfig.html @@ -1,4 +1,4 @@ -CuConfig in cu29_rendercfg::config - Rust

Struct CuConfig

Source
pub struct CuConfig {
+CuConfig in cu29_rendercfg::config - Rust

Struct CuConfig

Source
pub struct CuConfig {
     pub graph: StableDiGraph<Node, Cnx, u32>,
     pub monitor: Option<MonitorConfig>,
     pub logging: Option<LoggingConfig>,
diff --git a/cu29_rendercfg/config/struct.CuConfigRepresentation.html b/cu29_rendercfg/config/struct.CuConfigRepresentation.html
index af2bc095c..0c5661f56 100644
--- a/cu29_rendercfg/config/struct.CuConfigRepresentation.html
+++ b/cu29_rendercfg/config/struct.CuConfigRepresentation.html
@@ -1,4 +1,4 @@
-CuConfigRepresentation in cu29_rendercfg::config - Rust

Struct CuConfigRepresentation

Source
struct CuConfigRepresentation {
+CuConfigRepresentation in cu29_rendercfg::config - Rust

Struct CuConfigRepresentation

Source
struct CuConfigRepresentation {
     tasks: Vec<Node>,
     cnx: Vec<Cnx>,
     monitor: Option<MonitorConfig>,
diff --git a/cu29_rendercfg/config/struct.LoggingConfig.html b/cu29_rendercfg/config/struct.LoggingConfig.html
index 88b502bdc..708591912 100644
--- a/cu29_rendercfg/config/struct.LoggingConfig.html
+++ b/cu29_rendercfg/config/struct.LoggingConfig.html
@@ -1,4 +1,4 @@
-LoggingConfig in cu29_rendercfg::config - Rust

Struct LoggingConfig

Source
pub struct LoggingConfig {
+LoggingConfig in cu29_rendercfg::config - Rust

Struct LoggingConfig

Source
pub struct LoggingConfig {
     pub slab_size_mib: Option<u64>,
     pub section_size_mib: Option<u64>,
     pub enable_task_logging: bool,
diff --git a/cu29_rendercfg/config/struct.MonitorConfig.html b/cu29_rendercfg/config/struct.MonitorConfig.html
index e0f52155d..3928e8a66 100644
--- a/cu29_rendercfg/config/struct.MonitorConfig.html
+++ b/cu29_rendercfg/config/struct.MonitorConfig.html
@@ -1,4 +1,4 @@
-MonitorConfig in cu29_rendercfg::config - Rust

Struct MonitorConfig

Source
pub struct MonitorConfig {
+MonitorConfig in cu29_rendercfg::config - Rust

Struct MonitorConfig

Source
pub struct MonitorConfig {
     type_: String,
     config: Option<ComponentConfig>,
 }

Fields§

§type_: String§config: Option<ComponentConfig>

Implementations§

Trait Implementations§

Source§

impl Clone for MonitorConfig

Source§

fn clone(&self) -> MonitorConfig

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 MonitorConfig

Source§

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

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

impl Default for MonitorConfig

Source§

fn default() -> MonitorConfig

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

impl<'de> Deserialize<'de> for MonitorConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where diff --git a/cu29_rendercfg/config/struct.Node.html b/cu29_rendercfg/config/struct.Node.html index d6781055c..7caf591d8 100644 --- a/cu29_rendercfg/config/struct.Node.html +++ b/cu29_rendercfg/config/struct.Node.html @@ -1,4 +1,4 @@ -Node in cu29_rendercfg::config - Rust

Struct Node

Source
pub struct Node {
+Node in cu29_rendercfg::config - Rust

Struct Node

Source
pub struct Node {
     id: String,
     type_: Option<String>,
     config: Option<ComponentConfig>,
diff --git a/cu29_rendercfg/config/struct.Value.html b/cu29_rendercfg/config/struct.Value.html
index 24b98494d..17aae4553 100644
--- a/cu29_rendercfg/config/struct.Value.html
+++ b/cu29_rendercfg/config/struct.Value.html
@@ -1,4 +1,4 @@
-Value in cu29_rendercfg::config - Rust

Struct Value

Source
pub struct Value(Value);
Expand description

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

+Value in cu29_rendercfg::config - Rust

Struct Value

Source
pub struct Value(Value);
Expand description

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

Tuple Fields§

§0: Value

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

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 Value

Source§

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

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

impl<'de> Deserialize<'de> for Value

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Value

Source§

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

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

impl From<String> for Value

Source§

fn from(value: String) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for String

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for bool

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for f64

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for i32

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for u32

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for u8

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for Value

Source§

fn from(value: f64) -> Self

Converts to this type from the input type.
Source§

impl From<i32> for Value

Source§

fn from(value: i32) -> Self

Converts to this type from the input type.
Source§

impl From<u16> for Value

Source§

fn from(value: u16) -> Self

Converts to this type from the input type.
Source§

impl From<u32> for Value

Source§

fn from(value: u32) -> Self

Converts to this type from the input type.
Source§

impl From<u8> for Value

Source§

fn from(value: u8) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Value

Source§

fn eq(&self, other: &Value) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Value

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where diff --git a/cu29_rendercfg/config/type.NodeId.html b/cu29_rendercfg/config/type.NodeId.html index 6ef1967c7..51a356cf3 100644 --- a/cu29_rendercfg/config/type.NodeId.html +++ b/cu29_rendercfg/config/type.NodeId.html @@ -1,3 +1,3 @@ -NodeId in cu29_rendercfg::config - Rust

Type Alias NodeId

Source
pub type NodeId = u32;
Expand description

NodeId is the unique identifier of a node in the configuration graph for petgraph +NodeId in cu29_rendercfg::config - Rust

Type Alias NodeId

Source
pub type NodeId = u32;
Expand description

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

\ No newline at end of file diff --git a/cu29_rendercfg/enum.UnifiedLogType.html b/cu29_rendercfg/enum.UnifiedLogType.html index fda367f69..938377c37 100644 --- a/cu29_rendercfg/enum.UnifiedLogType.html +++ b/cu29_rendercfg/enum.UnifiedLogType.html @@ -1,4 +1,4 @@ -UnifiedLogType in cu29_rendercfg - Rust

Enum UnifiedLogType

pub enum UnifiedLogType {
+UnifiedLogType in cu29_rendercfg - Rust

Enum UnifiedLogType

pub enum UnifiedLogType {
     Empty,
     StructuredLogLine,
     CopperList,
diff --git a/cu29_rendercfg/fn.main.html b/cu29_rendercfg/fn.main.html
index d166f35f6..c600ac9e7 100644
--- a/cu29_rendercfg/fn.main.html
+++ b/cu29_rendercfg/fn.main.html
@@ -1,2 +1,2 @@
-main in cu29_rendercfg - Rust

Function main

Source
pub(crate) fn main() -> Result<()>
Expand description

Render the configuration file to a dot file then convert it to an SVG and optionally opens it with inkscape.

+main in cu29_rendercfg - Rust

Function main

Source
pub(crate) fn main() -> Result<()>
Expand description

Render the configuration file to a dot file then convert it to an SVG and optionally opens it with inkscape.

\ No newline at end of file diff --git a/cu29_rendercfg/index.html b/cu29_rendercfg/index.html index 72cd85757..5e013bfd9 100644 --- a/cu29_rendercfg/index.html +++ b/cu29_rendercfg/index.html @@ -1,4 +1,4 @@ -cu29_rendercfg - Rust

Crate cu29_rendercfg

Source

Modules§

config 🔒
This module defines the configuration of the copper runtime. +cu29_rendercfg - Rust

Crate cu29_rendercfg

Source

Modules§

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

Structs§

Args 🔒
CuError
Common copper Error type.

Enums§

UnifiedLogType
Defines the types of what can be logged in the unified logger.

Traits§

CopperListTuple
A CopperListTuple needs to be encodable, decodable and fixed size in memory.
WriteStream
Defines a basic write, append only stream trait to be able to log or send serializable objects.

Functions§

main 🔒
Render the configuration file to a dot file then convert it to an SVG and optionally opens it with inkscape.

Type Aliases§

CuResult
\ No newline at end of file diff --git a/cu29_rendercfg/struct.Args.html b/cu29_rendercfg/struct.Args.html index 35c85407c..2a3b48088 100644 --- a/cu29_rendercfg/struct.Args.html +++ b/cu29_rendercfg/struct.Args.html @@ -1,4 +1,4 @@ -Args in cu29_rendercfg - Rust

Struct Args

Source
pub(crate) struct Args {
+Args in cu29_rendercfg - Rust

Struct Args

Source
pub(crate) struct Args {
     pub(crate) config: PathBuf,
     pub(crate) open: bool,
 }

Fields§

§config: PathBuf

Config file name

diff --git a/cu29_rendercfg/struct.CuError.html b/cu29_rendercfg/struct.CuError.html index 60b84511c..7b8a6262a 100644 --- a/cu29_rendercfg/struct.CuError.html +++ b/cu29_rendercfg/struct.CuError.html @@ -1,4 +1,4 @@ -CuError in cu29_rendercfg - Rust

Struct CuError

pub struct CuError {
+CuError in cu29_rendercfg - Rust

Struct CuError

pub struct CuError {
     pub(crate) message: String,
     pub(crate) cause: Option<String>,
 }
Expand description

Common copper Error type.

diff --git a/cu29_rendercfg/trait.CopperListTuple.html b/cu29_rendercfg/trait.CopperListTuple.html index 5ef9fefea..e24558dba 100644 --- a/cu29_rendercfg/trait.CopperListTuple.html +++ b/cu29_rendercfg/trait.CopperListTuple.html @@ -1,4 +1,4 @@ -CopperListTuple in cu29_rendercfg - Rust

Trait CopperListTuple

pub trait CopperListTuple:
+CopperListTuple in cu29_rendercfg - Rust

Trait CopperListTuple

pub trait CopperListTuple:
     Sized
     + Encode
     + Decode
diff --git a/cu29_rendercfg/trait.WriteStream.html b/cu29_rendercfg/trait.WriteStream.html
index 2599c0375..bb875bab2 100644
--- a/cu29_rendercfg/trait.WriteStream.html
+++ b/cu29_rendercfg/trait.WriteStream.html
@@ -1,4 +1,4 @@
-WriteStream in cu29_rendercfg - Rust

Trait WriteStream

pub trait WriteStream<E>:
+WriteStream in cu29_rendercfg - Rust

Trait WriteStream

pub trait WriteStream<E>:
     Sync
     + Send
     + Debug
where diff --git a/cu29_rendercfg/type.CuResult.html b/cu29_rendercfg/type.CuResult.html index d0dce11d2..211047627 100644 --- a/cu29_rendercfg/type.CuResult.html +++ b/cu29_rendercfg/type.CuResult.html @@ -1,4 +1,4 @@ -CuResult in cu29_rendercfg - Rust

Type Alias CuResult

pub type CuResult<T> = Result<T, CuError>;

Aliased Type§

enum CuResult<T> {
+CuResult in cu29_rendercfg - Rust

Type Alias CuResult

pub type CuResult<T> = Result<T, CuError>;

Aliased Type§

enum CuResult<T> {
     Ok(T),
     Err(CuError),
 }

Variants§

§1.0.0

Ok(T)

Contains the success value

diff --git a/cu29_runtime/all.html b/cu29_runtime/all.html index 031245820..2184a58d3 100644 --- a/cu29_runtime/all.html +++ b/cu29_runtime/all.html @@ -1 +1 @@ -List of all items in this crate
\ No newline at end of file +List of all items in this crate
\ No newline at end of file diff --git a/cu29_runtime/config/fn.read_configuration.html b/cu29_runtime/config/fn.read_configuration.html index 16762c7ff..59fb4b81d 100644 --- a/cu29_runtime/config/fn.read_configuration.html +++ b/cu29_runtime/config/fn.read_configuration.html @@ -1,2 +1,2 @@ -read_configuration in cu29_runtime::config - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> CuResult<CuConfig>
Expand description

Read a copper configuration from a file.

+read_configuration in cu29_runtime::config - Rust

Function read_configuration

Source
pub fn read_configuration(config_filename: &str) -> CuResult<CuConfig>
Expand description

Read a copper configuration from a file.

\ No newline at end of file diff --git a/cu29_runtime/config/fn.read_configuration_str.html b/cu29_runtime/config/fn.read_configuration_str.html index 58f079142..8a6d527ec 100644 --- a/cu29_runtime/config/fn.read_configuration_str.html +++ b/cu29_runtime/config/fn.read_configuration_str.html @@ -1,2 +1,2 @@ -read_configuration_str in cu29_runtime::config - Rust

Function read_configuration_str

Source
pub fn read_configuration_str(config_content: String) -> CuResult<CuConfig>
Expand description

Read a copper configuration from a String.

+read_configuration_str in cu29_runtime::config - Rust

Function read_configuration_str

Source
pub fn read_configuration_str(config_content: String) -> CuResult<CuConfig>
Expand description

Read a copper configuration from a String.

\ No newline at end of file diff --git a/cu29_runtime/config/index.html b/cu29_runtime/config/index.html index 3e07824ad..7a372cfeb 100644 --- a/cu29_runtime/config/index.html +++ b/cu29_runtime/config/index.html @@ -1,4 +1,4 @@ -cu29_runtime::config - Rust

Module config

Source
Expand description

This module defines the configuration of the copper runtime. +cu29_runtime::config - Rust

Module config

Source
Expand description

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

diff --git a/cu29_runtime/config/struct.Cnx.html b/cu29_runtime/config/struct.Cnx.html index 9eac43365..d4715be18 100644 --- a/cu29_runtime/config/struct.Cnx.html +++ b/cu29_runtime/config/struct.Cnx.html @@ -1,4 +1,4 @@ -Cnx in cu29_runtime::config - Rust

Struct Cnx

Source
pub struct Cnx {
+Cnx in cu29_runtime::config - Rust

Struct Cnx

Source
pub struct Cnx {
     pub msg: String,
     pub batch: Option<u32>,
     pub store: Option<bool>,
diff --git a/cu29_runtime/config/struct.ComponentConfig.html b/cu29_runtime/config/struct.ComponentConfig.html
index 18221c395..15c98a987 100644
--- a/cu29_runtime/config/struct.ComponentConfig.html
+++ b/cu29_runtime/config/struct.ComponentConfig.html
@@ -1,4 +1,4 @@
-ComponentConfig in cu29_runtime::config - Rust

Struct ComponentConfig

Source
pub struct ComponentConfig(pub HashMap<String, Value>);
Expand description

This is the configuration of a component (like a task config or a monitoring config):w +ComponentConfig in cu29_runtime::config - Rust

Struct ComponentConfig

Source
pub struct ComponentConfig(pub HashMap<String, Value>);
Expand description

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

Tuple Fields§

§0: HashMap<String, Value>

Implementations§

Source§

impl ComponentConfig

Source

pub fn new() -> Self

Source

pub fn get<T: From<Value>>(&self, key: &str) -> Option<T>

Source

pub fn set<T: Into<Value>>(&mut self, key: &str, value: T)

Trait Implementations§

Source§

impl Clone for ComponentConfig

Source§

fn clone(&self) -> ComponentConfig

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 ComponentConfig

Source§

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

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

impl Default for ComponentConfig

Source§

fn default() -> ComponentConfig

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

impl<'de> Deserialize<'de> for ComponentConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where diff --git a/cu29_runtime/config/struct.CuConfig.html b/cu29_runtime/config/struct.CuConfig.html index a3fa4eb05..7d8f50d26 100644 --- a/cu29_runtime/config/struct.CuConfig.html +++ b/cu29_runtime/config/struct.CuConfig.html @@ -1,4 +1,4 @@ -CuConfig in cu29_runtime::config - Rust

Struct CuConfig

Source
pub struct CuConfig {
+CuConfig in cu29_runtime::config - Rust

Struct CuConfig

Source
pub struct CuConfig {
     pub graph: StableDiGraph<Node, Cnx, NodeId>,
     pub monitor: Option<MonitorConfig>,
     pub logging: Option<LoggingConfig>,
diff --git a/cu29_runtime/config/struct.LoggingConfig.html b/cu29_runtime/config/struct.LoggingConfig.html
index e32e11805..f7f1a5682 100644
--- a/cu29_runtime/config/struct.LoggingConfig.html
+++ b/cu29_runtime/config/struct.LoggingConfig.html
@@ -1,4 +1,4 @@
-LoggingConfig in cu29_runtime::config - Rust

Struct LoggingConfig

Source
pub struct LoggingConfig {
+LoggingConfig in cu29_runtime::config - Rust

Struct LoggingConfig

Source
pub struct LoggingConfig {
     pub slab_size_mib: Option<u64>,
     pub section_size_mib: Option<u64>,
     pub enable_task_logging: bool,
diff --git a/cu29_runtime/config/struct.MonitorConfig.html b/cu29_runtime/config/struct.MonitorConfig.html
index 149ab0abb..30753c4a4 100644
--- a/cu29_runtime/config/struct.MonitorConfig.html
+++ b/cu29_runtime/config/struct.MonitorConfig.html
@@ -1,4 +1,4 @@
-MonitorConfig in cu29_runtime::config - Rust

Struct MonitorConfig

Source
pub struct MonitorConfig { /* private fields */ }

Implementations§

Trait Implementations§

Source§

impl Clone for MonitorConfig

Source§

fn clone(&self) -> MonitorConfig

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 MonitorConfig

Source§

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

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

impl Default for MonitorConfig

Source§

fn default() -> MonitorConfig

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

impl<'de> Deserialize<'de> for MonitorConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where +MonitorConfig in cu29_runtime::config - Rust

Struct MonitorConfig

Source
pub struct MonitorConfig { /* private fields */ }

Implementations§

Trait Implementations§

Source§

impl Clone for MonitorConfig

Source§

fn clone(&self) -> MonitorConfig

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 MonitorConfig

Source§

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

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

impl Default for MonitorConfig

Source§

fn default() -> MonitorConfig

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

impl<'de> Deserialize<'de> for MonitorConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MonitorConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29_runtime/config/struct.Node.html b/cu29_runtime/config/struct.Node.html index b7ca84a3f..75e594419 100644 --- a/cu29_runtime/config/struct.Node.html +++ b/cu29_runtime/config/struct.Node.html @@ -1,4 +1,4 @@ -Node in cu29_runtime::config - Rust

Struct Node

Source
pub struct Node { /* private fields */ }
Expand description

A node in the configuration graph. +Node in cu29_runtime::config - Rust

Struct Node

Source
pub struct Node { /* private fields */ }
Expand description

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

Implementations§

Source§

impl Node

Source

pub fn new(id: &str, ptype: &str) -> Self

Source

pub fn get_id(&self) -> String

Source

pub fn set_type(self, name: Option<String>) -> Self

Source

pub fn get_type(&self) -> &str

Source

pub fn get_instance_config(&self) -> Option<&ComponentConfig>

Source

pub fn get_param<T: From<Value>>(&self, key: &str) -> Option<T>

Source

pub fn set_param<T: Into<Value>>(&mut self, key: &str, value: T)

Trait Implementations§

Source§

impl Clone for Node

Source§

fn clone(&self) -> Node

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 Node

Source§

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

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

impl<'de> Deserialize<'de> for Node

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Node

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where diff --git a/cu29_runtime/config/struct.Value.html b/cu29_runtime/config/struct.Value.html index 7f8830436..b4af05c9c 100644 --- a/cu29_runtime/config/struct.Value.html +++ b/cu29_runtime/config/struct.Value.html @@ -1,4 +1,4 @@ -Value in cu29_runtime::config - Rust

Struct Value

Source
pub struct Value(/* private fields */);
Expand description

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

+Value in cu29_runtime::config - Rust

Struct Value

Source
pub struct Value(/* private fields */);
Expand description

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

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

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 Value

Source§

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

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

impl<'de> Deserialize<'de> for Value

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Value

Source§

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

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

impl From<String> for Value

Source§

fn from(value: String) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for String

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for bool

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for f64

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for i32

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for u32

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<Value> for u8

Source§

fn from(value: Value) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for Value

Source§

fn from(value: f64) -> Self

Converts to this type from the input type.
Source§

impl From<i32> for Value

Source§

fn from(value: i32) -> Self

Converts to this type from the input type.
Source§

impl From<u16> for Value

Source§

fn from(value: u16) -> Self

Converts to this type from the input type.
Source§

impl From<u32> for Value

Source§

fn from(value: u32) -> Self

Converts to this type from the input type.
Source§

impl From<u8> for Value

Source§

fn from(value: u8) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Value

Source§

fn eq(&self, other: &Value) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Value

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where diff --git a/cu29_runtime/config/type.NodeId.html b/cu29_runtime/config/type.NodeId.html index 8d91ff34f..fd4ad4cfd 100644 --- a/cu29_runtime/config/type.NodeId.html +++ b/cu29_runtime/config/type.NodeId.html @@ -1,3 +1,3 @@ -NodeId in cu29_runtime::config - Rust

Type Alias NodeId

Source
pub type NodeId = u32;
Expand description

NodeId is the unique identifier of a node in the configuration graph for petgraph +NodeId in cu29_runtime::config - Rust

Type Alias NodeId

Source
pub type NodeId = u32;
Expand description

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

\ No newline at end of file diff --git a/cu29_runtime/copperlist/enum.CopperListState.html b/cu29_runtime/copperlist/enum.CopperListState.html index 3ced26ae2..5c7d39a70 100644 --- a/cu29_runtime/copperlist/enum.CopperListState.html +++ b/cu29_runtime/copperlist/enum.CopperListState.html @@ -1,4 +1,4 @@ -CopperListState in cu29_runtime::copperlist - Rust

Enum CopperListState

Source
pub enum CopperListState {
+CopperListState in cu29_runtime::copperlist - Rust

Enum CopperListState

Source
pub enum CopperListState {
     Free,
     Initialized,
     Processing,
diff --git a/cu29_runtime/copperlist/index.html b/cu29_runtime/copperlist/index.html
index fc352f3b9..e766e775e 100644
--- a/cu29_runtime/copperlist/index.html
+++ b/cu29_runtime/copperlist/index.html
@@ -1,4 +1,4 @@
-cu29_runtime::copperlist - Rust

Module copperlist

Source
Expand description

CopperList is the main data structure used by Copper to communicate between tasks. +cu29_runtime::copperlist - Rust

Module copperlist

Source
Expand description

CopperList is the main data structure used by Copper to communicate between tasks. It is a queue that can be used to store preallocated messages between tasks in memory order.

Structs§

CopperLiskMask
Not implemented yet. This mask will be used to for example filter out necessary regions of a copper list between remote systems.
CopperList
CuListsManager
This structure maintains the entire memory needed by Copper for one loop for the inter tasks communication within a process. diff --git a/cu29_runtime/copperlist/struct.CopperLiskMask.html b/cu29_runtime/copperlist/struct.CopperLiskMask.html index 8334f411d..1b242a733 100644 --- a/cu29_runtime/copperlist/struct.CopperLiskMask.html +++ b/cu29_runtime/copperlist/struct.CopperLiskMask.html @@ -1,4 +1,4 @@ -CopperLiskMask in cu29_runtime::copperlist - Rust

Struct CopperLiskMask

Source
pub struct CopperLiskMask { /* private fields */ }
Expand description

Not implemented yet. +CopperLiskMask in cu29_runtime::copperlist - Rust

Struct CopperLiskMask

Source
pub struct CopperLiskMask { /* private fields */ }
Expand description

Not implemented yet. This mask will be used to for example filter out necessary regions of a copper list between remote systems.

Trait Implementations§

Source§

impl<'__de> BorrowDecode<'__de> for CopperLiskMask

Source§

fn borrow_decode<__D: BorrowDecoder<'__de>>( decoder: &mut __D, diff --git a/cu29_runtime/copperlist/struct.CopperList.html b/cu29_runtime/copperlist/struct.CopperList.html index 31f5d0c02..afea41341 100644 --- a/cu29_runtime/copperlist/struct.CopperList.html +++ b/cu29_runtime/copperlist/struct.CopperList.html @@ -1,4 +1,4 @@ -CopperList in cu29_runtime::copperlist - Rust

Struct CopperList

Source
pub struct CopperList<P: CopperListTuple> {
+CopperList in cu29_runtime::copperlist - Rust

Struct CopperList

Source
pub struct CopperList<P: CopperListTuple> {
     pub id: u32,
     pub msgs: P,
     /* private fields */
diff --git a/cu29_runtime/copperlist/struct.CuListsManager.html b/cu29_runtime/copperlist/struct.CuListsManager.html
index b04874607..56598d841 100644
--- a/cu29_runtime/copperlist/struct.CuListsManager.html
+++ b/cu29_runtime/copperlist/struct.CuListsManager.html
@@ -1,4 +1,4 @@
-CuListsManager in cu29_runtime::copperlist - Rust

Struct CuListsManager

Source
pub struct CuListsManager<P: CopperListTuple, const N: usize> { /* private fields */ }
Expand description

This structure maintains the entire memory needed by Copper for one loop for the inter tasks communication within a process. +CuListsManager in cu29_runtime::copperlist - Rust

Struct CuListsManager

Source
pub struct CuListsManager<P: CopperListTuple, const N: usize> { /* private fields */ }
Expand description

This structure maintains the entire memory needed by Copper for one loop for the inter tasks communication within a process. P or Payload is typically a Tuple of various types of messages that are exchanged between tasks. N is the maximum number of in flight Copper List the runtime can support.

Implementations§

Source§

impl<P: CopperListTuple, const N: usize> CuListsManager<P, N>

Source

pub fn new() -> Self

Source

pub fn len(&self) -> usize

Returns the current number of elements in the queue.

diff --git a/cu29_runtime/copperlist/type.AscIter.html b/cu29_runtime/copperlist/type.AscIter.html index 9a7dc8459..206fb7ad8 100644 --- a/cu29_runtime/copperlist/type.AscIter.html +++ b/cu29_runtime/copperlist/type.AscIter.html @@ -1 +1 @@ -AscIter in cu29_runtime::copperlist - Rust

Type Alias AscIter

Source
pub type AscIter<'a, T> = Chain<Iter<'a, T>, Iter<'a, T>>;

Aliased Type§

struct AscIter<'a, T> { /* private fields */ }
\ No newline at end of file +AscIter in cu29_runtime::copperlist - Rust

Type Alias AscIter

Source
pub type AscIter<'a, T> = Chain<Iter<'a, T>, Iter<'a, T>>;

Aliased Type§

struct AscIter<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29_runtime/copperlist/type.AscIterMut.html b/cu29_runtime/copperlist/type.AscIterMut.html index 823b5bf50..b8299dce7 100644 --- a/cu29_runtime/copperlist/type.AscIterMut.html +++ b/cu29_runtime/copperlist/type.AscIterMut.html @@ -1 +1 @@ -AscIterMut in cu29_runtime::copperlist - Rust

Type Alias AscIterMut

Source
pub type AscIterMut<'a, T> = Chain<IterMut<'a, T>, IterMut<'a, T>>;

Aliased Type§

struct AscIterMut<'a, T> { /* private fields */ }
\ No newline at end of file +AscIterMut in cu29_runtime::copperlist - Rust

Type Alias AscIterMut

Source
pub type AscIterMut<'a, T> = Chain<IterMut<'a, T>, IterMut<'a, T>>;

Aliased Type§

struct AscIterMut<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29_runtime/copperlist/type.Iter.html b/cu29_runtime/copperlist/type.Iter.html index 06a5aeeeb..57daf3415 100644 --- a/cu29_runtime/copperlist/type.Iter.html +++ b/cu29_runtime/copperlist/type.Iter.html @@ -1 +1 @@ -Iter in cu29_runtime::copperlist - Rust

Type Alias Iter

Source
pub type Iter<'a, T> = Chain<Rev<Iter<'a, T>>, Rev<Iter<'a, T>>>;

Aliased Type§

struct Iter<'a, T> { /* private fields */ }
\ No newline at end of file +Iter in cu29_runtime::copperlist - Rust

Type Alias Iter

Source
pub type Iter<'a, T> = Chain<Rev<Iter<'a, T>>, Rev<Iter<'a, T>>>;

Aliased Type§

struct Iter<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29_runtime/copperlist/type.IterMut.html b/cu29_runtime/copperlist/type.IterMut.html index 8367d7f99..e522e31a3 100644 --- a/cu29_runtime/copperlist/type.IterMut.html +++ b/cu29_runtime/copperlist/type.IterMut.html @@ -1 +1 @@ -IterMut in cu29_runtime::copperlist - Rust

Type Alias IterMut

Source
pub type IterMut<'a, T> = Chain<Rev<IterMut<'a, T>>, Rev<IterMut<'a, T>>>;

Aliased Type§

struct IterMut<'a, T> { /* private fields */ }
\ No newline at end of file +IterMut in cu29_runtime::copperlist - Rust

Type Alias IterMut

Source
pub type IterMut<'a, T> = Chain<Rev<IterMut<'a, T>>, Rev<IterMut<'a, T>>>;

Aliased Type§

struct IterMut<'a, T> { /* private fields */ }
\ No newline at end of file diff --git a/cu29_runtime/curuntime/enum.CuExecutionUnit.html b/cu29_runtime/curuntime/enum.CuExecutionUnit.html index 872fecdad..d715421fc 100644 --- a/cu29_runtime/curuntime/enum.CuExecutionUnit.html +++ b/cu29_runtime/curuntime/enum.CuExecutionUnit.html @@ -1,4 +1,4 @@ -CuExecutionUnit in cu29_runtime::curuntime - Rust

Enum CuExecutionUnit

Source
pub enum CuExecutionUnit {
+CuExecutionUnit in cu29_runtime::curuntime - Rust

Enum CuExecutionUnit

Source
pub enum CuExecutionUnit {
     Step(CuExecutionStep),
     Loop(CuExecutionLoop),
 }
Expand description

This structure represents a step in the execution plan.

diff --git a/cu29_runtime/curuntime/enum.CuTaskType.html b/cu29_runtime/curuntime/enum.CuTaskType.html index f053e7eed..8914d8683 100644 --- a/cu29_runtime/curuntime/enum.CuTaskType.html +++ b/cu29_runtime/curuntime/enum.CuTaskType.html @@ -1,4 +1,4 @@ -CuTaskType in cu29_runtime::curuntime - Rust

Enum CuTaskType

Source
pub enum CuTaskType {
+CuTaskType in cu29_runtime::curuntime - Rust

Enum CuTaskType

Source
pub enum CuTaskType {
     Source,
     Regular,
     Sink,
diff --git a/cu29_runtime/curuntime/fn.compute_runtime_plan.html b/cu29_runtime/curuntime/fn.compute_runtime_plan.html
index f0af4352c..db6f79ccd 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

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. +compute_runtime_plan in cu29_runtime::curuntime - Rust

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/fn.find_task_type_for_id.html b/cu29_runtime/curuntime/fn.find_task_type_for_id.html index 5367ae7c7..340807c93 100644 --- a/cu29_runtime/curuntime/fn.find_task_type_for_id.html +++ b/cu29_runtime/curuntime/fn.find_task_type_for_id.html @@ -1,4 +1,4 @@ -find_task_type_for_id in cu29_runtime::curuntime - Rust

Function find_task_type_for_id

Source
pub fn find_task_type_for_id(
+find_task_type_for_id in cu29_runtime::curuntime - Rust

Function find_task_type_for_id

Source
pub fn find_task_type_for_id(
     graph: &StableDiGraph<Node, Cnx, NodeId>,
     node_id: NodeId,
 ) -> CuTaskType
\ No newline at end of file diff --git a/cu29_runtime/curuntime/index.html b/cu29_runtime/curuntime/index.html index fb91cb974..78d817f65 100644 --- a/cu29_runtime/curuntime/index.html +++ b/cu29_runtime/curuntime/index.html @@ -1,4 +1,4 @@ -cu29_runtime::curuntime - Rust

Module curuntime

Source
Expand description

CuRuntime is the heart of what copper is running on the robot. +cu29_runtime::curuntime - Rust

Module curuntime

Source
Expand description

CuRuntime is the heart of what copper is running on the robot. It is exposed to the user via the copper_runtime macro injecting it as a field in their application struct.

Structs§

CopperContext
Just a simple struct to hold the various bits needed to run a Copper application.
CuExecutionLoop
This structure represents a loop in the execution plan. It is used to represent a sequence of Execution units (loop or steps) that are executed diff --git a/cu29_runtime/curuntime/struct.CopperContext.html b/cu29_runtime/curuntime/struct.CopperContext.html index f3520801f..89d60ce79 100644 --- a/cu29_runtime/curuntime/struct.CopperContext.html +++ b/cu29_runtime/curuntime/struct.CopperContext.html @@ -1,4 +1,4 @@ -CopperContext in cu29_runtime::curuntime - Rust

Struct CopperContext

Source
pub struct CopperContext {
+CopperContext in cu29_runtime::curuntime - Rust

Struct CopperContext

Source
pub struct CopperContext {
     pub unified_logger: Arc<Mutex<UnifiedLoggerWrite>>,
     pub logger_runtime: LoggerRuntime,
     pub clock: RobotClock,
diff --git a/cu29_runtime/curuntime/struct.CuExecutionLoop.html b/cu29_runtime/curuntime/struct.CuExecutionLoop.html
index 37f82237a..68529670e 100644
--- a/cu29_runtime/curuntime/struct.CuExecutionLoop.html
+++ b/cu29_runtime/curuntime/struct.CuExecutionLoop.html
@@ -1,4 +1,4 @@
-CuExecutionLoop in cu29_runtime::curuntime - Rust

Struct CuExecutionLoop

Source
pub struct CuExecutionLoop {
+CuExecutionLoop in cu29_runtime::curuntime - Rust

Struct CuExecutionLoop

Source
pub struct CuExecutionLoop {
     pub steps: Vec<CuExecutionUnit>,
     pub loop_count: Option<u32>,
 }
Expand description

This structure represents a loop in the execution plan. diff --git a/cu29_runtime/curuntime/struct.CuExecutionStep.html b/cu29_runtime/curuntime/struct.CuExecutionStep.html index 22ad49065..0c8e7eca7 100644 --- a/cu29_runtime/curuntime/struct.CuExecutionStep.html +++ b/cu29_runtime/curuntime/struct.CuExecutionStep.html @@ -1,4 +1,4 @@ -CuExecutionStep in cu29_runtime::curuntime - Rust

Struct CuExecutionStep

Source
pub struct CuExecutionStep {
+CuExecutionStep in cu29_runtime::curuntime - Rust

Struct CuExecutionStep

Source
pub struct CuExecutionStep {
     pub node_id: NodeId,
     pub node: Node,
     pub task_type: CuTaskType,
diff --git a/cu29_runtime/curuntime/struct.CuRuntime.html b/cu29_runtime/curuntime/struct.CuRuntime.html
index 4e6a39c20..4b084b72e 100644
--- a/cu29_runtime/curuntime/struct.CuRuntime.html
+++ b/cu29_runtime/curuntime/struct.CuRuntime.html
@@ -1,4 +1,4 @@
-CuRuntime in cu29_runtime::curuntime - Rust

Struct CuRuntime

Source
pub struct CuRuntime<CT, P: CopperListTuple, M: CuMonitor, const NBCL: usize> {
+CuRuntime in cu29_runtime::curuntime - Rust

Struct CuRuntime

Source
pub struct CuRuntime<CT, P: CopperListTuple, M: CuMonitor, const NBCL: usize> {
     pub tasks: CT,
     pub monitor: M,
     pub copper_lists_manager: CuListsManager<P, NBCL>,
diff --git a/cu29_runtime/cutask/index.html b/cu29_runtime/cutask/index.html
index 1f9feab2e..7c69ce960 100644
--- a/cu29_runtime/cutask/index.html
+++ b/cu29_runtime/cutask/index.html
@@ -1,4 +1,4 @@
-cu29_runtime::cutask - Rust

Module cutask

Source
Expand description

This module contains all the main definition of the traits you need to implement +cu29_runtime::cutask - Rust

Module cutask

Source
Expand description

This module contains all the main definition of the traits you need to implement or interact with to create a Copper task.

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. diff --git a/cu29_runtime/cutask/struct.CuCompactString.html b/cu29_runtime/cutask/struct.CuCompactString.html index 06c6c1270..10b4236df 100644 --- a/cu29_runtime/cutask/struct.CuCompactString.html +++ b/cu29_runtime/cutask/struct.CuCompactString.html @@ -1,4 +1,4 @@ -CuCompactString in cu29_runtime::cutask - Rust

Struct CuCompactString

Source
pub struct CuCompactString(pub CompactString);

Tuple Fields§

§0: CompactString

Trait Implementations§

Source§

impl<'de> BorrowDecode<'de> for CuCompactString

Source§

fn borrow_decode<D: BorrowDecoder<'de>>( +CuCompactString in cu29_runtime::cutask - Rust

Struct CuCompactString

Source
pub struct CuCompactString(pub CompactString);

Tuple Fields§

§0: CompactString

Trait Implementations§

Source§

impl<'de> BorrowDecode<'de> for CuCompactString

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 CuCompactString

Source§

fn clone(&self) -> CuCompactString

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 CuCompactString

Source§

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

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

impl Decode for CuCompactString

Source§

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

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

impl Default for CuCompactString

Source§

fn default() -> CuCompactString

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

impl<'de> Deserialize<'de> for CuCompactString

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Encode for CuCompactString

Source§

fn encode<E: Encoder>(&self, encoder: &mut E) -> Result<(), EncodeError>

Encode a given type.
Source§

impl PartialEq for CuCompactString

Source§

fn eq(&self, other: &CuCompactString) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, diff --git a/cu29_runtime/cutask/struct.CuMsg.html b/cu29_runtime/cutask/struct.CuMsg.html index 37388f0d5..18381e25b 100644 --- a/cu29_runtime/cutask/struct.CuMsg.html +++ b/cu29_runtime/cutask/struct.CuMsg.html @@ -1,4 +1,4 @@ -CuMsg in cu29_runtime::cutask - Rust

Struct CuMsg

Source
pub struct CuMsg<T>
where +CuMsg in cu29_runtime::cutask - Rust

Struct CuMsg

Source
pub struct CuMsg<T>
where T: CuMsgPayload,
{ pub metadata: CuMsgMetadata, /* private fields */ diff --git a/cu29_runtime/cutask/struct.CuMsgMetadata.html b/cu29_runtime/cutask/struct.CuMsgMetadata.html index 5cd0590dd..3f00e44b9 100644 --- a/cu29_runtime/cutask/struct.CuMsgMetadata.html +++ b/cu29_runtime/cutask/struct.CuMsgMetadata.html @@ -1,4 +1,4 @@ -CuMsgMetadata in cu29_runtime::cutask - Rust

Struct CuMsgMetadata

Source
pub struct CuMsgMetadata {
+CuMsgMetadata in cu29_runtime::cutask - Rust

Struct CuMsgMetadata

Source
pub struct CuMsgMetadata {
     pub process_time: PartialCuTimeRange,
     pub tov: Tov,
     pub status_txt: CuCompactString,
diff --git a/cu29_runtime/cutask/trait.CuMsgPack.html b/cu29_runtime/cutask/trait.CuMsgPack.html
index 1b117f81d..b268cfca1 100644
--- a/cu29_runtime/cutask/trait.CuMsgPack.html
+++ b/cu29_runtime/cutask/trait.CuMsgPack.html
@@ -1 +1 @@
-CuMsgPack in cu29_runtime::cutask - Rust

Trait CuMsgPack

Source
pub trait CuMsgPack<'cl> { }

Implementations on Foreign Types§

Source§

impl CuMsgPack<'_> for ()

Source§

impl<'cl, T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>)

Source§

impl<'cl, T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl, T3: CuMsgPayload + 'cl> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>, &'cl CuMsg<T3>)

Source§

impl<'cl, T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl, T3: CuMsgPayload + 'cl, T4: CuMsgPayload + 'cl> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>, &'cl CuMsg<T3>, &'cl CuMsg<T4>)

Source§

impl<'cl, T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl, T3: CuMsgPayload + 'cl, T4: CuMsgPayload + 'cl, T5: CuMsgPayload + 'cl> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>, &'cl CuMsg<T3>, &'cl CuMsg<T4>, &'cl CuMsg<T5>)

Source§

impl<'cl, T: CuMsgPayload> CuMsgPack<'cl> for (&'cl CuMsg<T>,)

Source§

impl<'cl, T: CuMsgPayload> CuMsgPack<'cl> for (&'cl mut CuMsg<T>,)

Implementors§

Source§

impl<'cl, T: CuMsgPayload> CuMsgPack<'cl> for &'cl CuMsg<T>

Source§

impl<'cl, T: CuMsgPayload> CuMsgPack<'cl> for &'cl mut CuMsg<T>

\ No newline at end of file +CuMsgPack in cu29_runtime::cutask - Rust

Trait CuMsgPack

Source
pub trait CuMsgPack<'cl> { }

Implementations on Foreign Types§

Source§

impl CuMsgPack<'_> for ()

Source§

impl<'cl, T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>)

Source§

impl<'cl, T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl, T3: CuMsgPayload + 'cl> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>, &'cl CuMsg<T3>)

Source§

impl<'cl, T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl, T3: CuMsgPayload + 'cl, T4: CuMsgPayload + 'cl> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>, &'cl CuMsg<T3>, &'cl CuMsg<T4>)

Source§

impl<'cl, T1: CuMsgPayload + 'cl, T2: CuMsgPayload + 'cl, T3: CuMsgPayload + 'cl, T4: CuMsgPayload + 'cl, T5: CuMsgPayload + 'cl> CuMsgPack<'cl> for (&'cl CuMsg<T1>, &'cl CuMsg<T2>, &'cl CuMsg<T3>, &'cl CuMsg<T4>, &'cl CuMsg<T5>)

Source§

impl<'cl, T: CuMsgPayload> CuMsgPack<'cl> for (&'cl CuMsg<T>,)

Source§

impl<'cl, T: CuMsgPayload> CuMsgPack<'cl> for (&'cl mut CuMsg<T>,)

Implementors§

Source§

impl<'cl, T: CuMsgPayload> CuMsgPack<'cl> for &'cl CuMsg<T>

Source§

impl<'cl, T: CuMsgPayload> CuMsgPack<'cl> for &'cl mut CuMsg<T>

\ No newline at end of file diff --git a/cu29_runtime/cutask/trait.CuMsgPayload.html b/cu29_runtime/cutask/trait.CuMsgPayload.html index ccb03b018..4f47f103d 100644 --- a/cu29_runtime/cutask/trait.CuMsgPayload.html +++ b/cu29_runtime/cutask/trait.CuMsgPayload.html @@ -1,4 +1,4 @@ -CuMsgPayload in cu29_runtime::cutask - Rust

Trait CuMsgPayload

Source
pub trait CuMsgPayload:
+CuMsgPayload in cu29_runtime::cutask - Rust

Trait CuMsgPayload

Source
pub trait CuMsgPayload:
     Default
     + Debug
     + Clone
diff --git a/cu29_runtime/cutask/trait.CuSinkTask.html b/cu29_runtime/cutask/trait.CuSinkTask.html
index ab757d1b3..de3d915e7 100644
--- a/cu29_runtime/cutask/trait.CuSinkTask.html
+++ b/cu29_runtime/cutask/trait.CuSinkTask.html
@@ -1,4 +1,4 @@
-CuSinkTask in cu29_runtime::cutask - Rust

Trait CuSinkTask

Source
pub trait CuSinkTask<'cl>: Freezable {
+CuSinkTask in cu29_runtime::cutask - Rust

Trait CuSinkTask

Source
pub trait CuSinkTask<'cl>: Freezable {
     type Input: CuMsgPack<'cl>;
 
     // Required methods
diff --git a/cu29_runtime/cutask/trait.CuSrcTask.html b/cu29_runtime/cutask/trait.CuSrcTask.html
index 1cb9d5473..433f010de 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

Trait CuSrcTask

Source
pub trait CuSrcTask<'cl>: Freezable {
+CuSrcTask in cu29_runtime::cutask - Rust

Trait CuSrcTask

Source
pub trait CuSrcTask<'cl>: Freezable {
     type Output: CuMsgPack<'cl>;
 
     // Required methods
diff --git a/cu29_runtime/cutask/trait.CuTask.html b/cu29_runtime/cutask/trait.CuTask.html
index b2542458e..752490867 100644
--- a/cu29_runtime/cutask/trait.CuTask.html
+++ b/cu29_runtime/cutask/trait.CuTask.html
@@ -1,4 +1,4 @@
-CuTask in cu29_runtime::cutask - Rust

Trait CuTask

Source
pub trait CuTask<'cl>: Freezable {
+CuTask in cu29_runtime::cutask - Rust

Trait CuTask

Source
pub trait CuTask<'cl>: Freezable {
     type Input: CuMsgPack<'cl>;
     type Output: CuMsgPack<'cl>;
 
diff --git a/cu29_runtime/cutask/trait.Freezable.html b/cu29_runtime/cutask/trait.Freezable.html
index 6cc34ee5f..6ea6e13f3 100644
--- a/cu29_runtime/cutask/trait.Freezable.html
+++ b/cu29_runtime/cutask/trait.Freezable.html
@@ -1,4 +1,4 @@
-Freezable in cu29_runtime::cutask - Rust

Trait Freezable

Source
pub trait Freezable {
+Freezable in cu29_runtime::cutask - Rust

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> { ... }
diff --git a/cu29_runtime/index.html b/cu29_runtime/index.html
index 052c36559..3dca3afa3 100644
--- a/cu29_runtime/index.html
+++ b/cu29_runtime/index.html
@@ -1,4 +1,4 @@
-cu29_runtime - Rust

Crate cu29_runtime

Source
Expand description
logo +cu29_runtime - Rust

Crate cu29_runtime

Source
Expand description
logo

§

§Copper

copper GitHub last commit diff --git a/cu29_runtime/macro.input_msg.html b/cu29_runtime/macro.input_msg.html index 230ead25b..0435948f2 100644 --- a/cu29_runtime/macro.input_msg.html +++ b/cu29_runtime/macro.input_msg.html @@ -1,4 +1,4 @@ -input_msg in cu29_runtime - Rust

Macro input_msg

Source
macro_rules! input_msg {
+input_msg in cu29_runtime - Rust

Macro input_msg

Source
macro_rules! input_msg {
     ($lifetime:lifetime, $ty:ty) => { ... };
     ($lifetime:lifetime, $($ty:ty),*) => { ... };
 }
\ No newline at end of file diff --git a/cu29_runtime/macro.output_msg.html b/cu29_runtime/macro.output_msg.html index 05f4fea13..07302fc08 100644 --- a/cu29_runtime/macro.output_msg.html +++ b/cu29_runtime/macro.output_msg.html @@ -1,3 +1,3 @@ -output_msg in cu29_runtime - Rust

Macro output_msg

Source
macro_rules! output_msg {
+output_msg in cu29_runtime - Rust

Macro output_msg

Source
macro_rules! output_msg {
     ($lifetime:lifetime, $ty:ty) => { ... };
 }
\ No newline at end of file diff --git a/cu29_runtime/monitoring/enum.CuTaskState.html b/cu29_runtime/monitoring/enum.CuTaskState.html index 4d09e570c..9e2d5bd37 100644 --- a/cu29_runtime/monitoring/enum.CuTaskState.html +++ b/cu29_runtime/monitoring/enum.CuTaskState.html @@ -1,4 +1,4 @@ -CuTaskState in cu29_runtime::monitoring - Rust

Enum CuTaskState

Source
pub enum CuTaskState {
+CuTaskState in cu29_runtime::monitoring - Rust

Enum CuTaskState

Source
pub enum CuTaskState {
     Start,
     Preprocess,
     Process,
diff --git a/cu29_runtime/monitoring/enum.Decision.html b/cu29_runtime/monitoring/enum.Decision.html
index 31cc9434c..b5db58f2a 100644
--- a/cu29_runtime/monitoring/enum.Decision.html
+++ b/cu29_runtime/monitoring/enum.Decision.html
@@ -1,4 +1,4 @@
-Decision in cu29_runtime::monitoring - Rust

Enum Decision

Source
pub enum Decision {
+Decision in cu29_runtime::monitoring - Rust

Enum Decision

Source
pub enum Decision {
     Abort,
     Ignore,
     Shutdown,
diff --git a/cu29_runtime/monitoring/index.html b/cu29_runtime/monitoring/index.html
index 463bbb71b..affd673e3 100644
--- a/cu29_runtime/monitoring/index.html
+++ b/cu29_runtime/monitoring/index.html
@@ -1,4 +1,4 @@
-cu29_runtime::monitoring - Rust

Module monitoring

Source
Expand description

Some basic internal monitoring tooling Copper uses to monitor itself and the tasks it is running.

+cu29_runtime::monitoring - Rust

Module monitoring

Source
Expand description

Some basic internal monitoring tooling Copper uses to monitor itself and the tasks it is running.

Structs§

CountingAllocator
A simple allocator that counts the number of bytes allocated and deallocated.
CuDurationStatistics
A Specialized statistics object for CuDuration. It will also keep track of the jitter between the values.
LiveStatistics
Accumulative stat object that can give your some real time statistics.
NoMonitor
A do nothing monitor if no monitor is provided. This is basically defining the default behavior of Copper in case of error.
ScopedAllocCounter
A simple struct that counts the number of bytes allocated and deallocated in a scope.

Enums§

CuTaskState
The state of a task.
Decision
Monitor decision to be taken when a task errored out.

Statics§

GLOBAL

Traits§

CuMonitor
Trait to implement a monitoring task.
\ No newline at end of file diff --git a/cu29_runtime/monitoring/static.GLOBAL.html b/cu29_runtime/monitoring/static.GLOBAL.html index 64502eee6..c22bd2601 100644 --- a/cu29_runtime/monitoring/static.GLOBAL.html +++ b/cu29_runtime/monitoring/static.GLOBAL.html @@ -1 +1 @@ -GLOBAL in cu29_runtime::monitoring - Rust

Static GLOBAL

Source
pub static GLOBAL: CountingAllocator
\ No newline at end of file +GLOBAL in cu29_runtime::monitoring - Rust

Static GLOBAL

Source
pub static GLOBAL: CountingAllocator
\ No newline at end of file diff --git a/cu29_runtime/monitoring/struct.CountingAllocator.html b/cu29_runtime/monitoring/struct.CountingAllocator.html index bf8260ef5..f4f58883a 100644 --- a/cu29_runtime/monitoring/struct.CountingAllocator.html +++ b/cu29_runtime/monitoring/struct.CountingAllocator.html @@ -1,4 +1,4 @@ -CountingAllocator in cu29_runtime::monitoring - Rust

Struct CountingAllocator

Source
pub struct CountingAllocator { /* private fields */ }
Expand description

A simple allocator that counts the number of bytes allocated and deallocated.

+CountingAllocator in cu29_runtime::monitoring - Rust

Struct CountingAllocator

Source
pub struct CountingAllocator { /* private fields */ }
Expand description

A simple allocator that counts the number of bytes allocated and deallocated.

Implementations§

Source§

impl CountingAllocator

Source

pub const fn new() -> Self

Source

pub fn get_allocated(&self) -> usize

Source

pub fn get_deallocated(&self) -> usize

Source

pub fn reset(&self)

Trait Implementations§

Source§

impl Default for CountingAllocator

Source§

fn default() -> Self

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

impl GlobalAlloc for CountingAllocator

Source§

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocates memory as described by the given layout. Read more
Source§

unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout)

Deallocates the block of memory at the given ptr pointer with the given layout. Read more
1.28.0 · Source§

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

Behaves like alloc, but also ensures that the contents are set to zero before being returned. Read more
1.28.0 · Source§

unsafe fn realloc( &self, diff --git a/cu29_runtime/monitoring/struct.CuDurationStatistics.html b/cu29_runtime/monitoring/struct.CuDurationStatistics.html index c16f12ccd..3e439bbd0 100644 --- a/cu29_runtime/monitoring/struct.CuDurationStatistics.html +++ b/cu29_runtime/monitoring/struct.CuDurationStatistics.html @@ -1,4 +1,4 @@ -CuDurationStatistics in cu29_runtime::monitoring - Rust

Struct CuDurationStatistics

Source
pub struct CuDurationStatistics { /* private fields */ }
Expand description

A Specialized statistics object for CuDuration. +CuDurationStatistics in cu29_runtime::monitoring - Rust

Struct CuDurationStatistics

Source
pub struct CuDurationStatistics { /* private fields */ }
Expand description

A Specialized statistics object for CuDuration. It will also keep track of the jitter between the values.

Implementations§

Source§

impl CuDurationStatistics

Source

pub fn new(max: CuDuration) -> Self

Source

pub fn min(&self) -> CuDuration

Source

pub fn max(&self) -> CuDuration

Source

pub fn mean(&self) -> CuDuration

Source

pub fn percentile(&self, percentile: f64) -> CuDuration

Source

pub fn stddev(&self) -> CuDuration

Source

pub fn len(&self) -> u64

Source

pub fn is_empty(&self) -> bool

Source

pub fn jitter_min(&self) -> CuDuration

Source

pub fn jitter_max(&self) -> CuDuration

Source

pub fn jitter_mean(&self) -> CuDuration

Source

pub fn jitter_stddev(&self) -> CuDuration

Source

pub fn jitter_percentile(&self, percentile: f64) -> CuDuration

Source

pub fn record(&mut self, value: CuDuration)

Source

pub fn reset(&mut self)

Trait Implementations§

Source§

impl Clone for CuDurationStatistics

Source§

fn clone(&self) -> CuDurationStatistics

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 CuDurationStatistics

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29_runtime/monitoring/struct.LiveStatistics.html b/cu29_runtime/monitoring/struct.LiveStatistics.html index 51452748c..289c4bfae 100644 --- a/cu29_runtime/monitoring/struct.LiveStatistics.html +++ b/cu29_runtime/monitoring/struct.LiveStatistics.html @@ -1,4 +1,4 @@ -LiveStatistics in cu29_runtime::monitoring - Rust

Struct LiveStatistics

Source
pub struct LiveStatistics { /* private fields */ }
Expand description

Accumulative stat object that can give your some real time statistics.

+LiveStatistics in cu29_runtime::monitoring - Rust

Struct LiveStatistics

Source
pub struct LiveStatistics { /* private fields */ }
Expand description

Accumulative stat object that can give your some real time statistics.

Implementations§

Source§

impl LiveStatistics

Source

pub fn new_unbounded() -> Self

Source

pub fn new_with_max(max: u64) -> Self

Source

pub fn min(&self) -> u64

Source

pub fn max(&self) -> u64

Source

pub fn mean(&self) -> f64

Source

pub fn percentile(&self, percentile: f64) -> u64

Source

pub fn record(&mut self, value: u64)

Adds a value to the statistics.

Source

pub fn len(&self) -> u64

Source

pub fn is_empty(&self) -> bool

Source

pub fn reset(&mut self)

Trait Implementations§

Source§

impl Clone for LiveStatistics

Source§

fn clone(&self) -> LiveStatistics

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 LiveStatistics

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29_runtime/monitoring/struct.NoMonitor.html b/cu29_runtime/monitoring/struct.NoMonitor.html index 19f786c21..4733ca213 100644 --- a/cu29_runtime/monitoring/struct.NoMonitor.html +++ b/cu29_runtime/monitoring/struct.NoMonitor.html @@ -1,4 +1,4 @@ -NoMonitor in cu29_runtime::monitoring - Rust

Struct NoMonitor

Source
pub struct NoMonitor {}
Expand description

A do nothing monitor if no monitor is provided. +NoMonitor in cu29_runtime::monitoring - Rust

Struct NoMonitor

Source
pub struct NoMonitor {}
Expand description

A do nothing monitor if no monitor is provided. This is basically defining the default behavior of Copper in case of error.

Trait Implementations§

Source§

impl CuMonitor for NoMonitor

Source§

fn new(_config: &CuConfig, _taskids: &'static [&'static str]) -> CuResult<Self>

Source§

fn process_copperlist(&self, _msgs: &[&CuMsgMetadata]) -> CuResult<()>

Callback that will be trigger at the end of every copperlist (before, on or after the serialization).
Source§

fn process_error( &self, diff --git a/cu29_runtime/monitoring/struct.ScopedAllocCounter.html b/cu29_runtime/monitoring/struct.ScopedAllocCounter.html index 7c8625370..cf21582d9 100644 --- a/cu29_runtime/monitoring/struct.ScopedAllocCounter.html +++ b/cu29_runtime/monitoring/struct.ScopedAllocCounter.html @@ -1,4 +1,4 @@ -ScopedAllocCounter in cu29_runtime::monitoring - Rust

Struct ScopedAllocCounter

Source
pub struct ScopedAllocCounter { /* private fields */ }
Expand description

A simple struct that counts the number of bytes allocated and deallocated in a scope.

+ScopedAllocCounter in cu29_runtime::monitoring - Rust

Struct ScopedAllocCounter

Source
pub struct ScopedAllocCounter { /* private fields */ }
Expand description

A simple struct that counts the number of bytes allocated and deallocated in a scope.

Implementations§

Source§

impl ScopedAllocCounter

Source

pub fn new() -> Self

Source

pub fn get_allocated(&self) -> usize

Returns the total number of bytes allocated in the current scope since the creation of this ScopedAllocCounter.

§Example
diff --git a/cu29_runtime/monitoring/trait.CuMonitor.html b/cu29_runtime/monitoring/trait.CuMonitor.html index d72a46a0e..59b73956b 100644 --- a/cu29_runtime/monitoring/trait.CuMonitor.html +++ b/cu29_runtime/monitoring/trait.CuMonitor.html @@ -1,4 +1,4 @@ -CuMonitor in cu29_runtime::monitoring - Rust

Trait CuMonitor

Source
pub trait CuMonitor: Sized {
+CuMonitor in cu29_runtime::monitoring - Rust

Trait CuMonitor

Source
pub trait CuMonitor: Sized {
     // Required methods
     fn new(
         config: &CuConfig,
diff --git a/cu29_runtime/payload/index.html b/cu29_runtime/payload/index.html
index 78cd04100..67cd9664c 100644
--- a/cu29_runtime/payload/index.html
+++ b/cu29_runtime/payload/index.html
@@ -1 +1 @@
-cu29_runtime::payload - Rust

Module payload

Source

Structs§

CuArray
Copper friendly wrapper for a fixed size array.
\ No newline at end of file +cu29_runtime::payload - Rust

Module payload

Source

Structs§

CuArray
Copper friendly wrapper for a fixed size array.
\ No newline at end of file diff --git a/cu29_runtime/payload/struct.CuArray.html b/cu29_runtime/payload/struct.CuArray.html index 787d596c7..1c15520f3 100644 --- a/cu29_runtime/payload/struct.CuArray.html +++ b/cu29_runtime/payload/struct.CuArray.html @@ -1,4 +1,4 @@ -CuArray in cu29_runtime::payload - Rust

Struct CuArray

Source
pub struct CuArray<T, const N: usize> { /* private fields */ }
Expand description

Copper friendly wrapper for a fixed size array.

+CuArray in cu29_runtime::payload - Rust

Struct CuArray

Source
pub struct CuArray<T, const N: usize> { /* private fields */ }
Expand description

Copper friendly wrapper for a fixed size array.

Implementations§

Source§

impl<T, const N: usize> CuArray<T, N>

Source

pub fn new() -> Self

Source

pub fn fill_from_iter<I>(&mut self, iter: I)
where I: IntoIterator<Item = T>,

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn as_slice(&self) -> &[T]

Source

pub fn capacity(&self) -> usize

Trait Implementations§

Source§

impl<T: Clone, const N: usize> Clone for CuArray<T, N>

Source§

fn clone(&self) -> CuArray<T, N>

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<T: Debug, const N: usize> Debug for CuArray<T, N>

Source§

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

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

impl<T, const N: usize> Decode for CuArray<T, N>
where T: Decode,

Source§

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

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

impl<T: Default, const N: usize> Default for CuArray<T, N>

Source§

fn default() -> CuArray<T, N>

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

impl<T, const N: usize> Encode for CuArray<T, N>
where diff --git a/cu29_runtime/pool/enum.CuHandleInner.html b/cu29_runtime/pool/enum.CuHandleInner.html index ef487dc0d..651e79951 100644 --- a/cu29_runtime/pool/enum.CuHandleInner.html +++ b/cu29_runtime/pool/enum.CuHandleInner.html @@ -1,10 +1,10 @@ -CuHandleInner in cu29_runtime::pool - Rust

Enum CuHandleInner

Source
pub enum CuHandleInner<T: Debug> {
+CuHandleInner in cu29_runtime::pool - Rust

Enum CuHandleInner

Source
pub enum CuHandleInner<T: Debug> {
     Pooled(ReusableOwned<T>),
     Detached(T),
 }
Expand description

A Handle to a Buffer. For onboard usages, the buffer should be Pooled (ie, coming from a preallocated pool). The Detached version is for offline usages where we don’t really need a pool to deserialize them.

-

Variants§

§

Pooled(ReusableOwned<T>)

§

Detached(T)

Methods from Deref<Target = [T::Element]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where +

Variants§

§

Pooled(ReusableOwned<T>)

§

Detached(T)

Methods from Deref<Target = [T::Element]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Copy,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Copies the elements from src to self, returning a mutable reference to the now initialized contents of self.

If T does not implement Copy, use write_clone_of_slice instead.

@@ -36,7 +36,7 @@
§Examples
} assert_eq!(vec, src);
-

Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where +

Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Clone,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Clones the elements from src to self, returning a mutable reference to the now initialized contents of self. Any already initialized elements will not be dropped.

@@ -71,7 +71,7 @@
§Examples
} assert_eq!(vec, src);
-
Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

+
Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

§Examples
@@ -84,7 +84,7 @@
§Examples
let val1 = u16::from_ne_bytes(bytes[0..2].try_into().unwrap()); let val2 = u16::from_ne_bytes(bytes[2..4].try_into().unwrap()); assert_eq!(&[val1, val2], &[0x1234u16, 0x5678u16]);

-
Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially +

Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

@@ -101,7 +101,7 @@
§Examples
} else { assert_eq!(vals, &[0x1234u16, 0x5678u16]); }
-
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

+
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

§Safety

It is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state. Calling this when the content is not yet @@ -114,12 +114,12 @@

§Safety
requirement the compiler knows about it is that the data pointer must be non-null. Dropping such a Vec<T> however will cause undefined behaviour.

-
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

+
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state.

-
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

+
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the diff --git a/cu29_runtime/pool/fn.pools_statistics.html b/cu29_runtime/pool/fn.pools_statistics.html index ab3724e73..1f8938b39 100644 --- a/cu29_runtime/pool/fn.pools_statistics.html +++ b/cu29_runtime/pool/fn.pools_statistics.html @@ -1,3 +1,3 @@ -pools_statistics in cu29_runtime::pool - Rust

Function pools_statistics

Source
pub fn pools_statistics() -> SmallVec<[(ArrayString<64>, usize, usize, usize); 16]>
Expand description

Get the list of pools and their statistics. +pools_statistics in cu29_runtime::pool - Rust

Function pools_statistics

Source
pub fn pools_statistics() -> SmallVec<[(ArrayString<64>, usize, usize, usize); 16]>
Expand description

Get the list of pools and their statistics. We use SmallVec here to avoid heap allocations while the stack is running.

\ No newline at end of file diff --git a/cu29_runtime/pool/index.html b/cu29_runtime/pool/index.html index aae04e5a3..28cded5be 100644 --- a/cu29_runtime/pool/index.html +++ b/cu29_runtime/pool/index.html @@ -1,4 +1,4 @@ -cu29_runtime::pool - Rust

Module pool

Source

Structs§

AlignedBuffer
A buffer that is aligned to a specific size with the Element of type E.
CuHandle
A shareable handle to an Array coming from a pool (either host or device).
CuHostMemoryPool
A pool of host memory buffers.

Enums§

CuHandleInner
A Handle to a Buffer. +cu29_runtime::pool - Rust

Module pool

Source

Structs§

AlignedBuffer
A buffer that is aligned to a specific size with the Element of type E.
CuHandle
A shareable handle to an Array coming from a pool (either host or device).
CuHostMemoryPool
A pool of host memory buffers.

Enums§

CuHandleInner
A Handle to a Buffer. For onboard usages, the buffer should be Pooled (ie, coming from a preallocated pool). The Detached version is for offline usages where we don’t really need a pool to deserialize them.

Traits§

ArrayLike
CuPool
A CuPool is a pool of buffers that can be shared between different parts of the code. Handles can be stored locally in the tasks and shared between them.
DeviceCuPool
A device memory pool can copy data from a device to a host memory pool on top.
ElementType
Basic Type that can be used in a buffer in a CuPool.
PoolMonitor
Trait for a Pool to exposed to be monitored by the monitoring API.

Functions§

pools_statistics
Get the list of pools and their statistics. diff --git a/cu29_runtime/pool/struct.AlignedBuffer.html b/cu29_runtime/pool/struct.AlignedBuffer.html index 1fd0b962e..92e4dbc20 100644 --- a/cu29_runtime/pool/struct.AlignedBuffer.html +++ b/cu29_runtime/pool/struct.AlignedBuffer.html @@ -1,5 +1,5 @@ -AlignedBuffer in cu29_runtime::pool - Rust

Struct AlignedBuffer

Source
pub struct AlignedBuffer<E: ElementType> { /* private fields */ }
Expand description

A buffer that is aligned to a specific size with the Element of type E.

-

Implementations§

Source§

impl<E: ElementType> AlignedBuffer<E>

Source

pub fn new(num_elements: usize, alignment: usize) -> Self

Methods from Deref<Target = [E]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where +AlignedBuffer in cu29_runtime::pool - Rust

Struct AlignedBuffer

Source
pub struct AlignedBuffer<E: ElementType> { /* private fields */ }
Expand description

A buffer that is aligned to a specific size with the Element of type E.

+

Implementations§

Source§

impl<E: ElementType> AlignedBuffer<E>

Source

pub fn new(num_elements: usize, alignment: usize) -> Self

Methods from Deref<Target = [E]>§

Source

pub fn write_copy_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Copy,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Copies the elements from src to self, returning a mutable reference to the now initialized contents of self.

If T does not implement Copy, use write_clone_of_slice instead.

@@ -31,7 +31,7 @@
§Examples
} assert_eq!(vec, src);

-
Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where +

Source

pub fn write_clone_of_slice(&mut self, src: &[T]) -> &mut [T]
where T: Clone,

🔬This is a nightly-only experimental API. (maybe_uninit_write_slice)

Clones the elements from src to self, returning a mutable reference to the now initialized contents of self. Any already initialized elements will not be dropped.

@@ -66,7 +66,7 @@
§Examples
} assert_eq!(vec, src);
-
Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

+
Source

pub fn as_bytes(&self) -> &[MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit as a slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

§Examples
@@ -79,7 +79,7 @@
§Examples
let val1 = u16::from_ne_bytes(bytes[0..2].try_into().unwrap()); let val2 = u16::from_ne_bytes(bytes[2..4].try_into().unwrap()); assert_eq!(&[val1, val2], &[0x1234u16, 0x5678u16]);
-
Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially +

Source

pub fn as_bytes_mut(&mut self) -> &mut [MaybeUninit<u8>]

🔬This is a nightly-only experimental API. (maybe_uninit_as_bytes)

Returns the contents of this MaybeUninit slice as a mutable slice of potentially uninitialized bytes.

Note that even if the contents of a MaybeUninit have been initialized, the value may still contain padding bytes which are left uninitialized.

@@ -96,7 +96,7 @@
§Examples
} else { assert_eq!(vals, &[0x1234u16, 0x5678u16]); }
-
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

+
Source

pub unsafe fn assume_init_drop(&mut self)

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Drops the contained values in place.

§Safety

It is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state. Calling this when the content is not yet @@ -109,12 +109,12 @@

§Safety
requirement the compiler knows about it is that the data pointer must be non-null. Dropping such a Vec<T> however will cause undefined behaviour.

-
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

+
Source

pub unsafe fn assume_init_ref(&self) -> &[T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a shared reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the slice really is in an initialized state.

-
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

+
Source

pub unsafe fn assume_init_mut(&mut self) -> &mut [T]

🔬This is a nightly-only experimental API. (maybe_uninit_slice)

Gets a mutable (unique) reference to the contained value.

§Safety

Calling this when the content is not yet fully initialized causes undefined behavior: it is up to the caller to guarantee that every MaybeUninit<T> in the diff --git a/cu29_runtime/pool/struct.CuHandle.html b/cu29_runtime/pool/struct.CuHandle.html index 03f305f5f..e3a11bab0 100644 --- a/cu29_runtime/pool/struct.CuHandle.html +++ b/cu29_runtime/pool/struct.CuHandle.html @@ -1,4 +1,4 @@ -CuHandle in cu29_runtime::pool - Rust

Struct CuHandle

Source
pub struct CuHandle<T: ArrayLike>(/* private fields */);
Expand description

A shareable handle to an Array coming from a pool (either host or device).

+CuHandle in cu29_runtime::pool - Rust

Struct CuHandle

Source
pub struct CuHandle<T: ArrayLike>(/* private fields */);
Expand description

A shareable handle to an Array coming from a pool (either host or device).

Implementations§

Source§

impl<T: ArrayLike> CuHandle<T>

Source

pub fn new_detached(inner: T) -> Self

Create a new CuHandle not part of a Pool (not for onboard usages, use pools instead)

Source

pub fn with_inner<R>(&self, f: impl FnOnce(&CuHandleInner<T>) -> R) -> R

Safely access the inner value, applying a closure to it.

Source

pub fn with_inner_mut<R>(&self, f: impl FnOnce(&mut CuHandleInner<T>) -> R) -> R

Mutably access the inner value, applying a closure to it.

diff --git a/cu29_runtime/pool/struct.CuHostMemoryPool.html b/cu29_runtime/pool/struct.CuHostMemoryPool.html index 6d9e957c2..0a9a204f2 100644 --- a/cu29_runtime/pool/struct.CuHostMemoryPool.html +++ b/cu29_runtime/pool/struct.CuHostMemoryPool.html @@ -1,4 +1,4 @@ -CuHostMemoryPool in cu29_runtime::pool - Rust

Struct CuHostMemoryPool

Source
pub struct CuHostMemoryPool<T> { /* private fields */ }
Expand description

A pool of host memory buffers.

+CuHostMemoryPool in cu29_runtime::pool - Rust

Struct CuHostMemoryPool

Source
pub struct CuHostMemoryPool<T> { /* private fields */ }
Expand description

A pool of host memory buffers.

Implementations§

Source§

impl<T: ArrayLike + 'static> CuHostMemoryPool<T>

Source

pub fn new<F>( id: &str, size: usize, diff --git a/cu29_runtime/pool/trait.ArrayLike.html b/cu29_runtime/pool/trait.ArrayLike.html index 881cfc2a5..cb13a6703 100644 --- a/cu29_runtime/pool/trait.ArrayLike.html +++ b/cu29_runtime/pool/trait.ArrayLike.html @@ -1,4 +1,4 @@ -ArrayLike in cu29_runtime::pool - Rust

Trait ArrayLike

Source
pub trait ArrayLike:
+ArrayLike in cu29_runtime::pool - Rust

Trait ArrayLike

Source
pub trait ArrayLike:
     Deref<Target = [Self::Element]>
     + DerefMut
     + Debug
diff --git a/cu29_runtime/pool/trait.CuPool.html b/cu29_runtime/pool/trait.CuPool.html
index da9b548d0..b12473a62 100644
--- a/cu29_runtime/pool/trait.CuPool.html
+++ b/cu29_runtime/pool/trait.CuPool.html
@@ -1,4 +1,4 @@
-CuPool in cu29_runtime::pool - Rust

Trait CuPool

Source
pub trait CuPool<T: ArrayLike>: PoolMonitor {
+CuPool in cu29_runtime::pool - Rust

Trait CuPool

Source
pub trait CuPool<T: ArrayLike>: PoolMonitor {
     // Required methods
     fn acquire(&self) -> Option<CuHandle<T>>;
     fn copy_from<O>(&self, from: &mut CuHandle<O>) -> CuHandle<T>
diff --git a/cu29_runtime/pool/trait.DeviceCuPool.html b/cu29_runtime/pool/trait.DeviceCuPool.html
index cc6fa7fae..d2fc1a6dd 100644
--- a/cu29_runtime/pool/trait.DeviceCuPool.html
+++ b/cu29_runtime/pool/trait.DeviceCuPool.html
@@ -1,4 +1,4 @@
-DeviceCuPool in cu29_runtime::pool - Rust

Trait DeviceCuPool

Source
pub trait DeviceCuPool<T: ArrayLike>: CuPool<T> {
+DeviceCuPool in cu29_runtime::pool - Rust

Trait DeviceCuPool

Source
pub trait DeviceCuPool<T: ArrayLike>: CuPool<T> {
     // Required method
     fn copy_to_host_pool<O>(
         &self,
diff --git a/cu29_runtime/pool/trait.ElementType.html b/cu29_runtime/pool/trait.ElementType.html
index cfd96a187..f6e83b9a8 100644
--- a/cu29_runtime/pool/trait.ElementType.html
+++ b/cu29_runtime/pool/trait.ElementType.html
@@ -1,4 +1,4 @@
-ElementType in cu29_runtime::pool - Rust

Trait ElementType

Source
pub trait ElementType:
+ElementType in cu29_runtime::pool - Rust

Trait ElementType

Source
pub trait ElementType:
     Default
     + Sized
     + Copy
diff --git a/cu29_runtime/pool/trait.PoolMonitor.html b/cu29_runtime/pool/trait.PoolMonitor.html
index b8bffb58a..767dfa834 100644
--- a/cu29_runtime/pool/trait.PoolMonitor.html
+++ b/cu29_runtime/pool/trait.PoolMonitor.html
@@ -1,4 +1,4 @@
-PoolMonitor in cu29_runtime::pool - Rust

Trait PoolMonitor

Source
pub trait PoolMonitor: Send + Sync {
+PoolMonitor in cu29_runtime::pool - Rust

Trait PoolMonitor

Source
pub trait PoolMonitor: Send + Sync {
     // Required methods
     fn id(&self) -> ArrayString<64>;
     fn space_left(&self) -> usize;
diff --git a/cu29_runtime/simulation/enum.CuTaskCallbackState.html b/cu29_runtime/simulation/enum.CuTaskCallbackState.html
index 013964732..e0a64070c 100644
--- a/cu29_runtime/simulation/enum.CuTaskCallbackState.html
+++ b/cu29_runtime/simulation/enum.CuTaskCallbackState.html
@@ -1,4 +1,4 @@
-CuTaskCallbackState in cu29_runtime::simulation - Rust

Enum CuTaskCallbackState

Source
pub enum CuTaskCallbackState<'cl, I, O>
where +CuTaskCallbackState in cu29_runtime::simulation - Rust

Enum CuTaskCallbackState

Source
pub enum CuTaskCallbackState<'cl, I, O>
where I: CuMsgPack<'cl>, O: CuMsgPack<'cl>,
{ New(Option<ComponentConfig>), diff --git a/cu29_runtime/simulation/enum.SimOverride.html b/cu29_runtime/simulation/enum.SimOverride.html index da90c278e..9f8aa85f5 100644 --- a/cu29_runtime/simulation/enum.SimOverride.html +++ b/cu29_runtime/simulation/enum.SimOverride.html @@ -1,4 +1,4 @@ -SimOverride in cu29_runtime::simulation - Rust

Enum SimOverride

Source
pub enum SimOverride {
+SimOverride in cu29_runtime::simulation - Rust

Enum SimOverride

Source
pub enum SimOverride {
     ExecutedBySim,
     ExecuteByRuntime,
     Errored(String),
diff --git a/cu29_runtime/simulation/index.html b/cu29_runtime/simulation/index.html
index 3e4c0f3b5..cf1815e53 100644
--- a/cu29_runtime/simulation/index.html
+++ b/cu29_runtime/simulation/index.html
@@ -1,4 +1,4 @@
-cu29_runtime::simulation - Rust

Module simulation

Source
Expand description

§cu29::simulation Module

+cu29_runtime::simulation - Rust

Module simulation

Source
Expand description

§cu29::simulation Module

The cu29::simulation module provides an interface to simulate tasks in Copper-based systems. It offers structures, traits, and enums that enable hooking into the lifecycle of tasks, adapting their behavior, and integrating them with simulated hardware environments.

diff --git a/cu29_runtime/simulation/struct.CuSimSinkTask.html b/cu29_runtime/simulation/struct.CuSimSinkTask.html index 2ce6f025e..11e55b48f 100644 --- a/cu29_runtime/simulation/struct.CuSimSinkTask.html +++ b/cu29_runtime/simulation/struct.CuSimSinkTask.html @@ -1,4 +1,4 @@ -CuSimSinkTask in cu29_runtime::simulation - Rust

Struct CuSimSinkTask

Source
pub struct CuSimSinkTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a sink task for the simulations. +CuSimSinkTask in cu29_runtime::simulation - Rust

Struct CuSimSinkTask

Source
pub struct CuSimSinkTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a sink task for the simulations. It basically does nothing in place of a real driver so it won’t try to initialize any hardware.

Trait Implementations§

Source§

impl<'cl, T: CuMsgPayload + 'cl> CuSinkTask<'cl> for CuSimSinkTask<T>

Source§

type Input = &'cl CuMsg<T>

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. diff --git a/cu29_runtime/simulation/struct.CuSimSrcTask.html b/cu29_runtime/simulation/struct.CuSimSrcTask.html index ec8561e60..f555de134 100644 --- a/cu29_runtime/simulation/struct.CuSimSrcTask.html +++ b/cu29_runtime/simulation/struct.CuSimSrcTask.html @@ -1,4 +1,4 @@ -CuSimSrcTask in cu29_runtime::simulation - Rust

Struct CuSimSrcTask

Source
pub struct CuSimSrcTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a source task for the simulations. +CuSimSrcTask in cu29_runtime::simulation - Rust

Struct CuSimSrcTask

Source
pub struct CuSimSrcTask<T> { /* private fields */ }
Expand description

This is a placeholder task for a source task for the simulations. It basically does nothing in place of a real driver so it won’t try to initialize any hardware.

Trait Implementations§

Source§

impl<'cl, T: CuMsgPayload + 'cl> CuSrcTask<'cl> for CuSimSrcTask<T>

Source§

type Output = &'cl mut CuMsg<T>

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. diff --git a/cu29_soa_derive/all.html b/cu29_soa_derive/all.html index 3366a8e2c..f3c70414d 100644 --- a/cu29_soa_derive/all.html +++ b/cu29_soa_derive/all.html @@ -1 +1 @@ -List of all items in this crate

List of all items

Derive Macros

\ No newline at end of file +List of all items in this crate

List of all items

Derive Macros

\ No newline at end of file diff --git a/cu29_soa_derive/derive.Soa.html b/cu29_soa_derive/derive.Soa.html index c5a93455f..ead73170d 100644 --- a/cu29_soa_derive/derive.Soa.html +++ b/cu29_soa_derive/derive.Soa.html @@ -1,4 +1,4 @@ -Soa in cu29_soa_derive - Rust

Derive Macro Soa

Source
#[derive(Soa)]
Expand description

Build a fixed sized SoA (Structure of Arrays) from a struct. +Soa in cu29_soa_derive - Rust

Derive Macro Soa

Source
#[derive(Soa)]
Expand description

Build a fixed sized SoA (Structure of Arrays) from a struct. The outputted SoA will be suitable for in place storage in messages and should be easier for the compiler to vectorize.

for example:

diff --git a/cu29_soa_derive/index.html b/cu29_soa_derive/index.html index ebce6275f..edb5d8919 100644 --- a/cu29_soa_derive/index.html +++ b/cu29_soa_derive/index.html @@ -1,3 +1,3 @@ -cu29_soa_derive - Rust

Crate cu29_soa_derive

Source

Derive Macros§

Soa
Build a fixed sized SoA (Structure of Arrays) from a struct. +cu29_soa_derive - Rust

Crate cu29_soa_derive

Source

Derive Macros§

Soa
Build a fixed sized SoA (Structure of Arrays) from a struct. The outputted SoA will be suitable for in place storage in messages and should be easier for the compiler to vectorize.
\ No newline at end of file diff --git a/cu29_traits/all.html b/cu29_traits/all.html index 730534fef..e4330caa3 100644 --- a/cu29_traits/all.html +++ b/cu29_traits/all.html @@ -1 +1 @@ -List of all items in this crate

List of all items

Structs

Enums

Traits

Type Aliases

\ No newline at end of file +List of all items in this crate

List of all items

Structs

Enums

Traits

Type Aliases

\ No newline at end of file diff --git a/cu29_traits/enum.UnifiedLogType.html b/cu29_traits/enum.UnifiedLogType.html index 28adbbf50..eb981f891 100644 --- a/cu29_traits/enum.UnifiedLogType.html +++ b/cu29_traits/enum.UnifiedLogType.html @@ -1,4 +1,4 @@ -UnifiedLogType in cu29_traits - Rust

Enum UnifiedLogType

Source
pub enum UnifiedLogType {
+UnifiedLogType in cu29_traits - Rust

Enum UnifiedLogType

Source
pub enum UnifiedLogType {
     Empty,
     StructuredLogLine,
     CopperList,
diff --git a/cu29_traits/index.html b/cu29_traits/index.html
index 5f62ad516..de2d76d21 100644
--- a/cu29_traits/index.html
+++ b/cu29_traits/index.html
@@ -1 +1 @@
-cu29_traits - Rust

Crate cu29_traits

Source

Structs§

CuError
Common copper Error type.

Enums§

UnifiedLogType
Defines the types of what can be logged in the unified logger.

Traits§

CopperListTuple
A CopperListTuple needs to be encodable, decodable and fixed size in memory.
WriteStream
Defines a basic write, append only stream trait to be able to log or send serializable objects.

Type Aliases§

CuResult
\ No newline at end of file +cu29_traits - Rust

Crate cu29_traits

Source

Structs§

CuError
Common copper Error type.

Enums§

UnifiedLogType
Defines the types of what can be logged in the unified logger.

Traits§

CopperListTuple
A CopperListTuple needs to be encodable, decodable and fixed size in memory.
WriteStream
Defines a basic write, append only stream trait to be able to log or send serializable objects.

Type Aliases§

CuResult
\ No newline at end of file diff --git a/cu29_traits/struct.CuError.html b/cu29_traits/struct.CuError.html index efdcab718..e0a2579f7 100644 --- a/cu29_traits/struct.CuError.html +++ b/cu29_traits/struct.CuError.html @@ -1,4 +1,4 @@ -CuError in cu29_traits - Rust

Struct CuError

Source
pub struct CuError { /* private fields */ }
Expand description

Common copper Error type.

+CuError in cu29_traits - Rust

Struct CuError

Source
pub struct CuError { /* private fields */ }
Expand description

Common copper Error type.

Implementations§

Source§

impl CuError

Source

pub fn new_with_cause(message: &str, cause: impl Error) -> CuError

Source

pub fn add_cause(self, context: &str) -> CuError

Trait Implementations§

Source§

impl Clone for CuError

Source§

fn clone(&self) -> CuError

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 CuError

Source§

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

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

impl<'de> Deserialize<'de> for CuError

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for CuError

Source§

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

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

impl Error for CuError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<&str> for CuError

Source§

fn from(s: &str) -> CuError

Converts to this type from the input type.
Source§

impl From<String> for CuError

Source§

fn from(s: String) -> CuError

Converts to this type from the input type.
Source§

impl Serialize for CuError

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where diff --git a/cu29_traits/trait.CopperListTuple.html b/cu29_traits/trait.CopperListTuple.html index 0ff26fe1e..297de9f46 100644 --- a/cu29_traits/trait.CopperListTuple.html +++ b/cu29_traits/trait.CopperListTuple.html @@ -1,4 +1,4 @@ -CopperListTuple in cu29_traits - Rust

Trait CopperListTuple

Source
pub trait CopperListTuple:
+CopperListTuple in cu29_traits - Rust

Trait CopperListTuple

Source
pub trait CopperListTuple:
     Encode
     + Decode
     + Sized
diff --git a/cu29_traits/trait.WriteStream.html b/cu29_traits/trait.WriteStream.html
index 127b9f73a..c975e77d4 100644
--- a/cu29_traits/trait.WriteStream.html
+++ b/cu29_traits/trait.WriteStream.html
@@ -1,4 +1,4 @@
-WriteStream in cu29_traits - Rust

Trait WriteStream

Source
pub trait WriteStream<E: Encode>:
+WriteStream in cu29_traits - Rust

Trait WriteStream

Source
pub trait WriteStream<E: Encode>:
     Sync
     + Send
     + Debug {
diff --git a/cu29_traits/type.CuResult.html b/cu29_traits/type.CuResult.html
index 15c69a9fe..f79c50c1a 100644
--- a/cu29_traits/type.CuResult.html
+++ b/cu29_traits/type.CuResult.html
@@ -1,4 +1,4 @@
-CuResult in cu29_traits - Rust

Type Alias CuResult

Source
pub type CuResult<T> = Result<T, CuError>;

Aliased Type§

enum CuResult<T> {
+CuResult in cu29_traits - Rust

Type Alias CuResult

Source
pub type CuResult<T> = Result<T, CuError>;

Aliased Type§

enum CuResult<T> {
     Ok(T),
     Err(CuError),
 }

Variants§

§1.0.0

Ok(T)

Contains the success value

diff --git a/cu29_unifiedlog/all.html b/cu29_unifiedlog/all.html index da21559e2..d6a3475b2 100644 --- a/cu29_unifiedlog/all.html +++ b/cu29_unifiedlog/all.html @@ -1 +1 @@ -List of all items in this crate
\ No newline at end of file +List of all items in this crate
\ No newline at end of file diff --git a/cu29_unifiedlog/enum.AllocatedSection.html b/cu29_unifiedlog/enum.AllocatedSection.html index 47a2b49c5..4d39892f3 100644 --- a/cu29_unifiedlog/enum.AllocatedSection.html +++ b/cu29_unifiedlog/enum.AllocatedSection.html @@ -1,4 +1,4 @@ -AllocatedSection in cu29_unifiedlog - Rust

Enum AllocatedSection

Source
pub enum AllocatedSection {
+AllocatedSection in cu29_unifiedlog - Rust

Enum AllocatedSection

Source
pub enum AllocatedSection {
     NoMoreSpace,
     Section(SectionHandle),
 }

Variants§

§

NoMoreSpace

§

Section(SectionHandle)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where diff --git a/cu29_unifiedlog/enum.UnifiedLogger.html b/cu29_unifiedlog/enum.UnifiedLogger.html index 0051307b7..ee3c6519f 100644 --- a/cu29_unifiedlog/enum.UnifiedLogger.html +++ b/cu29_unifiedlog/enum.UnifiedLogger.html @@ -1,4 +1,4 @@ -UnifiedLogger in cu29_unifiedlog - Rust

Enum UnifiedLogger

Source
pub enum UnifiedLogger {
+UnifiedLogger in cu29_unifiedlog - Rust

Enum UnifiedLogger

Source
pub enum UnifiedLogger {
     Read(UnifiedLoggerRead),
     Write(UnifiedLoggerWrite),
 }
Expand description

Holder of the read or write side of the datalogger.

diff --git a/cu29_unifiedlog/fn.stream_write.html b/cu29_unifiedlog/fn.stream_write.html index 83540d809..72a277fc6 100644 --- a/cu29_unifiedlog/fn.stream_write.html +++ b/cu29_unifiedlog/fn.stream_write.html @@ -1,4 +1,4 @@ -stream_write in cu29_unifiedlog - Rust

Function stream_write

Source
pub fn stream_write<E: Encode>(
+stream_write in cu29_unifiedlog - Rust

Function stream_write

Source
pub fn stream_write<E: Encode>(
     logger: Arc<Mutex<UnifiedLoggerWrite>>,
     entry_type: UnifiedLogType,
     minimum_allocation_amount: usize,
diff --git a/cu29_unifiedlog/index.html b/cu29_unifiedlog/index.html
index 60f1b3b0b..2004756a7 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. +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 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§

AllocatedSection
UnifiedLogger
Holder of the read or write side of the datalogger.

Functions§

stream_write
Create a new stream to write to the unifiedlogger.
\ No newline at end of file diff --git a/cu29_unifiedlog/struct.SectionHandle.html b/cu29_unifiedlog/struct.SectionHandle.html index 2984bb749..a80491781 100644 --- a/cu29_unifiedlog/struct.SectionHandle.html +++ b/cu29_unifiedlog/struct.SectionHandle.html @@ -1,4 +1,4 @@ -SectionHandle in cu29_unifiedlog - Rust

Struct SectionHandle

Source
pub struct SectionHandle { /* private fields */ }
Expand description

A SectionHandle is a handle to a section in the datalogger. +SectionHandle in cu29_unifiedlog - Rust

Struct SectionHandle

Source
pub struct SectionHandle { /* private fields */ }
Expand description

A SectionHandle is a handle to a section in the datalogger. It allows to track the lifecycle of a section of the datalogger.

Implementations§

Source§

impl SectionHandle

Source

pub fn create(section_header: SectionHeader, buffer: &'static mut [u8]) -> Self

Source

pub fn get_user_buffer(&mut self) -> &mut [u8]

Source

pub fn update_header(&mut self)

Trait Implementations§

Source§

impl Default for SectionHandle

Source§

fn default() -> SectionHandle

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

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29_unifiedlog/struct.SectionHeader.html b/cu29_unifiedlog/struct.SectionHeader.html index cd33e2b01..7fe6b8f89 100644 --- a/cu29_unifiedlog/struct.SectionHeader.html +++ b/cu29_unifiedlog/struct.SectionHeader.html @@ -1,4 +1,4 @@ -SectionHeader in cu29_unifiedlog - Rust

Struct SectionHeader

Source
pub struct SectionHeader { /* private fields */ }
Expand description

Each concurrent sublogger is tracked through a section header. +SectionHeader in cu29_unifiedlog - Rust

Struct SectionHeader

Source
pub struct SectionHeader { /* private fields */ }
Expand description

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.

Trait Implementations§

Source§

impl<'__de> BorrowDecode<'__de> for SectionHeader

Source§

fn borrow_decode<__D: BorrowDecoder<'__de>>( diff --git a/cu29_unifiedlog/struct.UnifiedLoggerBuilder.html b/cu29_unifiedlog/struct.UnifiedLoggerBuilder.html index 8734eb166..344120c72 100644 --- a/cu29_unifiedlog/struct.UnifiedLoggerBuilder.html +++ b/cu29_unifiedlog/struct.UnifiedLoggerBuilder.html @@ -1,4 +1,4 @@ -UnifiedLoggerBuilder in cu29_unifiedlog - Rust

Struct UnifiedLoggerBuilder

Source
pub struct UnifiedLoggerBuilder { /* private fields */ }
Expand description

Use this builder to create a new DataLogger.

+UnifiedLoggerBuilder in cu29_unifiedlog - Rust

Struct UnifiedLoggerBuilder

Source
pub struct UnifiedLoggerBuilder { /* private fields */ }
Expand description

Use this builder to create a new DataLogger.

Implementations§

Source§

impl UnifiedLoggerBuilder

Source

pub fn new() -> Self

Source

pub fn file_base_name(self, file_path: &Path) -> Self

If “something/toto.copper” is given, it will find or create “something/toto_0.copper”, “something/toto_1.copper” etc.

Source

pub fn preallocated_size(self, preallocated_size: usize) -> Self

Source

pub fn write(self, write: bool) -> Self

Source

pub fn create(self, create: bool) -> Self

Source

pub fn build(self) -> Result<UnifiedLogger>

Trait Implementations§

Source§

impl Default for UnifiedLoggerBuilder

Source§

fn default() -> Self

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

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where diff --git a/cu29_unifiedlog/struct.UnifiedLoggerIOReader.html b/cu29_unifiedlog/struct.UnifiedLoggerIOReader.html index fe58759ed..f0c5bb780 100644 --- a/cu29_unifiedlog/struct.UnifiedLoggerIOReader.html +++ b/cu29_unifiedlog/struct.UnifiedLoggerIOReader.html @@ -1,4 +1,4 @@ -UnifiedLoggerIOReader in cu29_unifiedlog - Rust

Struct UnifiedLoggerIOReader

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

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

+UnifiedLoggerIOReader in cu29_unifiedlog - Rust

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/cu29_unifiedlog/struct.UnifiedLoggerRead.html b/cu29_unifiedlog/struct.UnifiedLoggerRead.html index 293d8e09a..d817ef713 100644 --- a/cu29_unifiedlog/struct.UnifiedLoggerRead.html +++ b/cu29_unifiedlog/struct.UnifiedLoggerRead.html @@ -1,4 +1,4 @@ -UnifiedLoggerRead in cu29_unifiedlog - Rust

Struct UnifiedLoggerRead

Source
pub struct UnifiedLoggerRead { /* private fields */ }
Expand description

A read side of the datalogger.

+UnifiedLoggerRead in cu29_unifiedlog - Rust

Struct UnifiedLoggerRead

Source
pub struct UnifiedLoggerRead { /* private fields */ }
Expand description

A read side of the datalogger.

Implementations§

Source§

impl UnifiedLoggerRead

Source

pub fn new(base_file_path: &Path) -> Result<Self>

Source

pub fn read_next_section_type( &mut self, datalogtype: UnifiedLogType, diff --git a/cu29_unifiedlog/struct.UnifiedLoggerWrite.html b/cu29_unifiedlog/struct.UnifiedLoggerWrite.html index 6b9f54702..0c0191370 100644 --- a/cu29_unifiedlog/struct.UnifiedLoggerWrite.html +++ b/cu29_unifiedlog/struct.UnifiedLoggerWrite.html @@ -1,4 +1,4 @@ -UnifiedLoggerWrite in cu29_unifiedlog - Rust

Struct UnifiedLoggerWrite

Source
pub struct UnifiedLoggerWrite { /* private fields */ }
Expand description

A write side of the datalogger.

+UnifiedLoggerWrite in cu29_unifiedlog - Rust

Struct UnifiedLoggerWrite

Source
pub struct UnifiedLoggerWrite { /* private fields */ }
Expand description

A write side of the datalogger.

Implementations§

Source§

impl UnifiedLoggerWrite

Source

pub fn flush_section(&mut self, section: &mut SectionHandle)

Source

pub fn stats(&self) -> (usize, Vec<usize>, usize)

Trait Implementations§

Source§

impl Drop for UnifiedLoggerWrite

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where diff --git a/help.html b/help.html index 9af958062..2d4a5941b 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/index.html b/index.html index c05aeda00..3a1c7f189 100644 --- a/index.html +++ b/index.html @@ -1,2 +1,2 @@ -Index of crates
+Index of crates
\ No newline at end of file diff --git a/settings.html b/settings.html index 18303f93d..454af0574 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/lib.rs.html b/src/cu29/lib.rs.html index 96aaf344d..a8bcb836b 100644 --- a/src/cu29/lib.rs.html +++ b/src/cu29/lib.rs.html @@ -1,4 +1,4 @@ -lib.rs - source

cu29/
lib.rs

+lib.rs - source

cu29/
lib.rs

 1
 2
 3
diff --git a/src/cu29_clock/lib.rs.html b/src/cu29_clock/lib.rs.html
index 21f806ee4..d2f9d5dec 100644
--- a/src/cu29_clock/lib.rs.html
+++ b/src/cu29_clock/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_clock/
lib.rs

+lib.rs - source

cu29_clock/
lib.rs

 1
 2
 3
diff --git a/src/cu29_derive/format.rs.html b/src/cu29_derive/format.rs.html
index 5ffedc2e0..095e0368b 100644
--- a/src/cu29_derive/format.rs.html
+++ b/src/cu29_derive/format.rs.html
@@ -1,4 +1,4 @@
-format.rs - source

cu29_derive/
format.rs

+format.rs - source

cu29_derive/
format.rs

 1
 2
 3
diff --git a/src/cu29_derive/lib.rs.html b/src/cu29_derive/lib.rs.html
index bb288f942..22604beff 100644
--- a/src/cu29_derive/lib.rs.html
+++ b/src/cu29_derive/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_derive/
lib.rs

+lib.rs - source

cu29_derive/
lib.rs

 1
 2
 3
diff --git a/src/cu29_derive/utils.rs.html b/src/cu29_derive/utils.rs.html
index c9f1281ed..d1300f730 100644
--- a/src/cu29_derive/utils.rs.html
+++ b/src/cu29_derive/utils.rs.html
@@ -1,4 +1,4 @@
-utils.rs - source

cu29_derive/
utils.rs

+utils.rs - source

cu29_derive/
utils.rs

 1
 2
 3
diff --git a/src/cu29_export/lib.rs.html b/src/cu29_export/lib.rs.html
index 769319dc8..c06ddcf3a 100644
--- a/src/cu29_export/lib.rs.html
+++ b/src/cu29_export/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_export/
lib.rs

+lib.rs - source

cu29_export/
lib.rs

 1
 2
 3
diff --git a/src/cu29_helpers/lib.rs.html b/src/cu29_helpers/lib.rs.html
index e09be1058..c578bd2f2 100644
--- a/src/cu29_helpers/lib.rs.html
+++ b/src/cu29_helpers/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_helpers/
lib.rs

+lib.rs - source

cu29_helpers/
lib.rs

 1
 2
 3
diff --git a/src/cu29_intern_strs/lib.rs.html b/src/cu29_intern_strs/lib.rs.html
index 2f5e22a17..cb839a2d3 100644
--- a/src/cu29_intern_strs/lib.rs.html
+++ b/src/cu29_intern_strs/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_intern_strs/
lib.rs

+lib.rs - source

cu29_intern_strs/
lib.rs

 1
 2
 3
diff --git a/src/cu29_log/lib.rs.html b/src/cu29_log/lib.rs.html
index 7c9d7bb25..948e15cae 100644
--- a/src/cu29_log/lib.rs.html
+++ b/src/cu29_log/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_log/
lib.rs

+lib.rs - source

cu29_log/
lib.rs

 1
 2
 3
diff --git a/src/cu29_log_derive/index.rs.html b/src/cu29_log_derive/index.rs.html
index 2b1b29a40..3919bee45 100644
--- a/src/cu29_log_derive/index.rs.html
+++ b/src/cu29_log_derive/index.rs.html
@@ -1,4 +1,4 @@
-index.rs - source

cu29_log_derive/
index.rs

+index.rs - source

cu29_log_derive/
index.rs

 1
 2
 3
diff --git a/src/cu29_log_derive/lib.rs.html b/src/cu29_log_derive/lib.rs.html
index 3c4a5dfd3..9242f8cd8 100644
--- a/src/cu29_log_derive/lib.rs.html
+++ b/src/cu29_log_derive/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_log_derive/
lib.rs

+lib.rs - source

cu29_log_derive/
lib.rs

 1
 2
 3
diff --git a/src/cu29_log_runtime/lib.rs.html b/src/cu29_log_runtime/lib.rs.html
index c20f43abc..9179f6ce0 100644
--- a/src/cu29_log_runtime/lib.rs.html
+++ b/src/cu29_log_runtime/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_log_runtime/
lib.rs

+lib.rs - source

cu29_log_runtime/
lib.rs

 1
 2
 3
diff --git a/src/cu29_rendercfg/config.rs.html b/src/cu29_rendercfg/config.rs.html
index 698ce6a29..6f86d228f 100644
--- a/src/cu29_rendercfg/config.rs.html
+++ b/src/cu29_rendercfg/config.rs.html
@@ -1,4 +1,4 @@
-config.rs - source

cu29_rendercfg/
config.rs

+config.rs - source

cu29_rendercfg/
config.rs

 1
 2
 3
diff --git a/src/cu29_rendercfg/rendercfg.rs.html b/src/cu29_rendercfg/rendercfg.rs.html
index a3765f7f1..9c2312a88 100644
--- a/src/cu29_rendercfg/rendercfg.rs.html
+++ b/src/cu29_rendercfg/rendercfg.rs.html
@@ -1,4 +1,4 @@
-rendercfg.rs - source

cu29_rendercfg/
rendercfg.rs

+rendercfg.rs - source

cu29_rendercfg/
rendercfg.rs

 1
 2
 3
diff --git a/src/cu29_runtime/config.rs.html b/src/cu29_runtime/config.rs.html
index 61dabe4f4..c2bba4b27 100644
--- a/src/cu29_runtime/config.rs.html
+++ b/src/cu29_runtime/config.rs.html
@@ -1,4 +1,4 @@
-config.rs - source

cu29_runtime/
config.rs

+config.rs - source

cu29_runtime/
config.rs

 1
 2
 3
diff --git a/src/cu29_runtime/copperlist.rs.html b/src/cu29_runtime/copperlist.rs.html
index 153d3f2da..4301415b9 100644
--- a/src/cu29_runtime/copperlist.rs.html
+++ b/src/cu29_runtime/copperlist.rs.html
@@ -1,4 +1,4 @@
-copperlist.rs - source

cu29_runtime/
copperlist.rs

+copperlist.rs - source

cu29_runtime/
copperlist.rs

 1
 2
 3
diff --git a/src/cu29_runtime/curuntime.rs.html b/src/cu29_runtime/curuntime.rs.html
index c17c2ab6f..9d9a522d6 100644
--- a/src/cu29_runtime/curuntime.rs.html
+++ b/src/cu29_runtime/curuntime.rs.html
@@ -1,4 +1,4 @@
-curuntime.rs - source

cu29_runtime/
curuntime.rs

+curuntime.rs - source

cu29_runtime/
curuntime.rs

 1
 2
 3
diff --git a/src/cu29_runtime/cutask.rs.html b/src/cu29_runtime/cutask.rs.html
index 454e3afc6..a833e7bb4 100644
--- a/src/cu29_runtime/cutask.rs.html
+++ b/src/cu29_runtime/cutask.rs.html
@@ -1,4 +1,4 @@
-cutask.rs - source

cu29_runtime/
cutask.rs

+cutask.rs - source

cu29_runtime/
cutask.rs

 1
 2
 3
diff --git a/src/cu29_runtime/lib.rs.html b/src/cu29_runtime/lib.rs.html
index 661800c85..24026de2d 100644
--- a/src/cu29_runtime/lib.rs.html
+++ b/src/cu29_runtime/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_runtime/
lib.rs

+lib.rs - source

cu29_runtime/
lib.rs

 1
 2
 3
diff --git a/src/cu29_runtime/log.rs.html b/src/cu29_runtime/log.rs.html
index b757cf160..0b540fda8 100644
--- a/src/cu29_runtime/log.rs.html
+++ b/src/cu29_runtime/log.rs.html
@@ -1,4 +1,4 @@
-log.rs - source

cu29_runtime/
log.rs

+log.rs - source

cu29_runtime/
log.rs

 1
 2
 3
diff --git a/src/cu29_runtime/monitoring.rs.html b/src/cu29_runtime/monitoring.rs.html
index 05faf4818..5c60a43fc 100644
--- a/src/cu29_runtime/monitoring.rs.html
+++ b/src/cu29_runtime/monitoring.rs.html
@@ -1,4 +1,4 @@
-monitoring.rs - source

cu29_runtime/
monitoring.rs

+monitoring.rs - source

cu29_runtime/
monitoring.rs

 1
 2
 3
diff --git a/src/cu29_runtime/payload.rs.html b/src/cu29_runtime/payload.rs.html
index 61c598095..2e5610539 100644
--- a/src/cu29_runtime/payload.rs.html
+++ b/src/cu29_runtime/payload.rs.html
@@ -1,4 +1,4 @@
-payload.rs - source

cu29_runtime/
payload.rs

+payload.rs - source

cu29_runtime/
payload.rs

 1
 2
 3
diff --git a/src/cu29_runtime/pool.rs.html b/src/cu29_runtime/pool.rs.html
index 366870ce1..cb521ddac 100644
--- a/src/cu29_runtime/pool.rs.html
+++ b/src/cu29_runtime/pool.rs.html
@@ -1,4 +1,4 @@
-pool.rs - source

cu29_runtime/
pool.rs

+pool.rs - source

cu29_runtime/
pool.rs

 1
 2
 3
diff --git a/src/cu29_runtime/simulation.rs.html b/src/cu29_runtime/simulation.rs.html
index f3f0431f5..bafee3dae 100644
--- a/src/cu29_runtime/simulation.rs.html
+++ b/src/cu29_runtime/simulation.rs.html
@@ -1,4 +1,4 @@
-simulation.rs - source

cu29_runtime/
simulation.rs

+simulation.rs - source

cu29_runtime/
simulation.rs

 1
 2
 3
diff --git a/src/cu29_soa_derive/format.rs.html b/src/cu29_soa_derive/format.rs.html
index 961801bc0..0d3748fcb 100644
--- a/src/cu29_soa_derive/format.rs.html
+++ b/src/cu29_soa_derive/format.rs.html
@@ -1,4 +1,4 @@
-format.rs - source

cu29_soa_derive/
format.rs

+format.rs - source

cu29_soa_derive/
format.rs

 1
 2
 3
diff --git a/src/cu29_soa_derive/lib.rs.html b/src/cu29_soa_derive/lib.rs.html
index c77363b1d..52b8cac81 100644
--- a/src/cu29_soa_derive/lib.rs.html
+++ b/src/cu29_soa_derive/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_soa_derive/
lib.rs

+lib.rs - source

cu29_soa_derive/
lib.rs

 1
 2
 3
diff --git a/src/cu29_traits/lib.rs.html b/src/cu29_traits/lib.rs.html
index 20647965b..ddfe59c74 100644
--- a/src/cu29_traits/lib.rs.html
+++ b/src/cu29_traits/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_traits/
lib.rs

+lib.rs - source

cu29_traits/
lib.rs

 1
 2
 3
diff --git a/src/cu29_unifiedlog/lib.rs.html b/src/cu29_unifiedlog/lib.rs.html
index ea1f8096a..03cd5db75 100644
--- a/src/cu29_unifiedlog/lib.rs.html
+++ b/src/cu29_unifiedlog/lib.rs.html
@@ -1,4 +1,4 @@
-lib.rs - source

cu29_unifiedlog/
lib.rs

+lib.rs - source

cu29_unifiedlog/
lib.rs

 1
 2
 3