Skip to content

Commit

Permalink
deploy: 94e54bc
Browse files Browse the repository at this point in the history
  • Loading branch information
gbin committed Jan 18, 2025
1 parent 4fc15b7 commit b17d889
Show file tree
Hide file tree
Showing 18 changed files with 34 additions and 38 deletions.
2 changes: 1 addition & 1 deletion cu29/all.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion cu29/prelude/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
They form a linked list of sections.
The entry type is used to identify the type of data in the section.</div></li><li><div class="item-name"><a class="struct" href="struct.SimpleFileWriter.html" title="struct cu29::prelude::SimpleFileWriter">Simple<wbr>File<wbr>Writer</a></div><div class="desc docblock-short">This allows this crate to be used outside of Copper (ie. decoupling it from the unifiedlog.</div></li><li><div class="item-name"><a class="struct" href="struct.UnifiedLoggerBuilder.html" title="struct cu29::prelude::UnifiedLoggerBuilder">Unified<wbr>Logger<wbr>Builder</a></div><div class="desc docblock-short">Use this builder to create a new DataLogger.</div></li><li><div class="item-name"><a class="struct" href="struct.UnifiedLoggerIOReader.html" title="struct cu29::prelude::UnifiedLoggerIOReader">Unified<wbr>LoggerIO<wbr>Reader</a></div><div class="desc docblock-short">This a convenience wrapper around the UnifiedLoggerRead to implement the Read trait.</div></li><li><div class="item-name"><a class="struct" href="struct.UnifiedLoggerRead.html" title="struct cu29::prelude::UnifiedLoggerRead">Unified<wbr>Logger<wbr>Read</a></div><div class="desc docblock-short">A read side of the datalogger.</div></li><li><div class="item-name"><a class="struct" href="struct.UnifiedLoggerWrite.html" title="struct cu29::prelude::UnifiedLoggerWrite">Unified<wbr>Logger<wbr>Write</a></div><div class="desc docblock-short">A write side of the datalogger.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.AllocatedSection.html" title="enum cu29::prelude::AllocatedSection">Allocated<wbr>Section</a></div></li><li><div class="item-name"><a class="enum" href="enum.CopperListState.html" title="enum cu29::prelude::CopperListState">Copper<wbr>List<wbr>State</a></div><div class="desc docblock-short">Those are the possible states along the lifetime of a CopperList.</div></li><li><div class="item-name"><a class="enum" href="enum.CuExecutionUnit.html" title="enum cu29::prelude::CuExecutionUnit">CuExecution<wbr>Unit</a></div><div class="desc docblock-short">This structure represents a step in the execution plan.</div></li><li><div class="item-name"><a class="enum" href="enum.CuHandleInner.html" title="enum cu29::prelude::CuHandleInner">CuHandle<wbr>Inner</a></div></li><li><div class="item-name"><a class="enum" href="enum.CuTaskCallbackState.html" title="enum cu29::prelude::CuTaskCallbackState">CuTask<wbr>Callback<wbr>State</a></div><div class="desc docblock-short">This is the state that will be passed to the simulation support to hook
into the lifecycle of the tasks.</div></li><li><div class="item-name"><a class="enum" href="enum.CuTaskState.html" title="enum cu29::prelude::CuTaskState">CuTask<wbr>State</a></div><div class="desc docblock-short">The state of a task.</div></li><li><div class="item-name"><a class="enum" href="enum.CuTaskType.html" title="enum cu29::prelude::CuTaskType">CuTask<wbr>Type</a></div><div class="desc docblock-short">Copper tasks can be of 3 types:</div></li><li><div class="item-name"><a class="enum" href="enum.Decision.html" title="enum cu29::prelude::Decision">Decision</a></div><div class="desc docblock-short">Monitor decision to be taken when a task errored out.</div></li><li><div class="item-name"><a class="enum" href="enum.SimOverride.html" title="enum cu29::prelude::SimOverride">SimOverride</a></div><div class="desc docblock-short">This is the answer the simulator can give to control the simulation flow.</div></li><li><div class="item-name"><a class="enum" href="enum.Tov.html" title="enum cu29::prelude::Tov">Tov</a></div><div class="desc docblock-short">The time of validity of a message can be more than one time but can be a time range of Tovs.
For example a sub scan for a lidar, a set of images etc… can have a range of validity.</div></li><li><div class="item-name"><a class="enum" href="enum.UnifiedLogType.html" title="enum cu29::prelude::UnifiedLogType">Unified<wbr>LogType</a></div><div class="desc docblock-short">Defines the types of what can be logged in the unified logger.</div></li><li><div class="item-name"><a class="enum" href="enum.UnifiedLogger.html" title="enum cu29::prelude::UnifiedLogger">Unified<wbr>Logger</a></div><div class="desc docblock-short">Holder of the read or write side of the datalogger.</div></li><li><div class="item-name"><a class="enum" href="enum.Value.html" title="enum cu29::prelude::Value">Value</a></div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.ANONYMOUS.html" title="constant cu29::prelude::ANONYMOUS">ANONYMOUS</a></div></li><li><div class="item-name"><a class="constant" href="constant.MAX_LOG_PARAMS_ON_STACK.html" title="constant cu29::prelude::MAX_LOG_PARAMS_ON_STACK">MAX_<wbr>LOG_<wbr>PARAMS_<wbr>ON_<wbr>STACK</a></div></li></ul><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="static" href="static.GLOBAL.html" title="static cu29::prelude::GLOBAL">GLOBAL</a></div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.ArrayLike.html" title="trait cu29::prelude::ArrayLike">Array<wbr>Like</a></div></li><li><div class="item-name"><a class="trait" href="trait.ClockProvider.html" title="trait cu29::prelude::ClockProvider">Clock<wbr>Provider</a></div><div class="desc docblock-short">A trait to provide a clock to the runtime.</div></li><li><div class="item-name"><a class="trait" href="trait.CopperListTuple.html" title="trait cu29::prelude::CopperListTuple">Copper<wbr>List<wbr>Tuple</a></div><div class="desc docblock-short">A CopperListTuple needs to be encodable, decodable and fixed size in memory.</div></li><li><div class="item-name"><a class="trait" href="trait.CuMonitor.html" title="trait cu29::prelude::CuMonitor">CuMonitor</a></div><div class="desc docblock-short">Trait to implement a monitoring task.</div></li><li><div class="item-name"><a class="trait" href="trait.CuMsgPack.html" title="trait cu29::prelude::CuMsgPack">CuMsg<wbr>Pack</a></div></li><li><div class="item-name"><a class="trait" href="trait.CuMsgPayload.html" title="trait cu29::prelude::CuMsgPayload">CuMsg<wbr>Payload</a></div></li><li><div class="item-name"><a class="trait" href="trait.CuPool.html" title="trait cu29::prelude::CuPool">CuPool</a></div></li><li><div class="item-name"><a class="trait" href="trait.CuSinkTask.html" title="trait cu29::prelude::CuSinkTask">CuSink<wbr>Task</a></div><div class="desc docblock-short">A Sink Task is a task that only consumes messages. For example drivers for actuators are Sink Tasks.</div></li><li><div class="item-name"><a class="trait" href="trait.CuSrcTask.html" title="trait cu29::prelude::CuSrcTask">CuSrc<wbr>Task</a></div><div class="desc docblock-short">A Src Task is a task that only produces messages. For example drivers for sensors are Src Tasks.
For example a sub scan for a lidar, a set of images etc… can have a range of validity.</div></li><li><div class="item-name"><a class="enum" href="enum.UnifiedLogType.html" title="enum cu29::prelude::UnifiedLogType">Unified<wbr>LogType</a></div><div class="desc docblock-short">Defines the types of what can be logged in the unified logger.</div></li><li><div class="item-name"><a class="enum" href="enum.UnifiedLogger.html" title="enum cu29::prelude::UnifiedLogger">Unified<wbr>Logger</a></div><div class="desc docblock-short">Holder of the read or write side of the datalogger.</div></li><li><div class="item-name"><a class="enum" href="enum.Value.html" title="enum cu29::prelude::Value">Value</a></div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.ANONYMOUS.html" title="constant cu29::prelude::ANONYMOUS">ANONYMOUS</a></div></li><li><div class="item-name"><a class="constant" href="constant.MAX_LOG_PARAMS_ON_STACK.html" title="constant cu29::prelude::MAX_LOG_PARAMS_ON_STACK">MAX_<wbr>LOG_<wbr>PARAMS_<wbr>ON_<wbr>STACK</a></div></li></ul><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="static" href="static.EXTRA_TEXT_LOGGER.html" title="static cu29::prelude::EXTRA_TEXT_LOGGER">EXTRA_<wbr>TEXT_<wbr>LOGGER</a></div></li><li><div class="item-name"><a class="static" href="static.GLOBAL.html" title="static cu29::prelude::GLOBAL">GLOBAL</a></div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.ArrayLike.html" title="trait cu29::prelude::ArrayLike">Array<wbr>Like</a></div></li><li><div class="item-name"><a class="trait" href="trait.ClockProvider.html" title="trait cu29::prelude::ClockProvider">Clock<wbr>Provider</a></div><div class="desc docblock-short">A trait to provide a clock to the runtime.</div></li><li><div class="item-name"><a class="trait" href="trait.CopperListTuple.html" title="trait cu29::prelude::CopperListTuple">Copper<wbr>List<wbr>Tuple</a></div><div class="desc docblock-short">A CopperListTuple needs to be encodable, decodable and fixed size in memory.</div></li><li><div class="item-name"><a class="trait" href="trait.CuMonitor.html" title="trait cu29::prelude::CuMonitor">CuMonitor</a></div><div class="desc docblock-short">Trait to implement a monitoring task.</div></li><li><div class="item-name"><a class="trait" href="trait.CuMsgPack.html" title="trait cu29::prelude::CuMsgPack">CuMsg<wbr>Pack</a></div></li><li><div class="item-name"><a class="trait" href="trait.CuMsgPayload.html" title="trait cu29::prelude::CuMsgPayload">CuMsg<wbr>Payload</a></div></li><li><div class="item-name"><a class="trait" href="trait.CuPool.html" title="trait cu29::prelude::CuPool">CuPool</a></div></li><li><div class="item-name"><a class="trait" href="trait.CuSinkTask.html" title="trait cu29::prelude::CuSinkTask">CuSink<wbr>Task</a></div><div class="desc docblock-short">A Sink Task is a task that only consumes messages. For example drivers for actuators are Sink Tasks.</div></li><li><div class="item-name"><a class="trait" href="trait.CuSrcTask.html" title="trait cu29::prelude::CuSrcTask">CuSrc<wbr>Task</a></div><div class="desc docblock-short">A Src Task is a task that only produces messages. For example drivers for sensors are Src Tasks.
They are in push mode from the runtime.
To set the frequency of the pulls and align them to any hw, see the runtime configuration.
Note: A source has the privilege to have a clock passed to it vs a frozen clock.</div></li><li><div class="item-name"><a class="trait" href="trait.CuTask.html" title="trait cu29::prelude::CuTask">CuTask</a></div><div class="desc docblock-short">This is the most generic Task of copper. It is a “transform” task deriving an output from an input.</div></li><li><div class="item-name"><a class="trait" href="trait.DeviceCuPool.html" title="trait cu29::prelude::DeviceCuPool">Device<wbr>CuPool</a></div></li><li><div class="item-name"><a class="trait" href="trait.ElementType.html" title="trait cu29::prelude::ElementType">Element<wbr>Type</a></div><div class="desc docblock-short">Basic Type that can be used in a buffer in a CuPool.</div></li><li><div class="item-name"><a class="trait" href="trait.Freezable.html" title="trait cu29::prelude::Freezable">Freezable</a></div><div class="desc docblock-short">The internal state of a task needs to be serializable
Expand Down
2 changes: 1 addition & 1 deletion cu29/prelude/sidebar-items.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions cu29/prelude/static.EXTRA_TEXT_LOGGER.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `EXTRA_TEXT_LOGGER` static in crate `cu29`."><title>EXTRA_TEXT_LOGGER in cu29::prelude - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-c579a84d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="cu29" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (6067b3631 2025-01-17)" data-channel="nightly" data-search-js="search-ccb196c1.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc static"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../cu29/index.html">cu29</a><span class="version">0.5.2</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cu29::<wbr>prelude</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">cu29</a>::<wbr><a href="index.html">prelude</a></span><h1>Static <span class="static">EXTRA_TEXT_LOGGER</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub static EXTRA_TEXT_LOGGER: <a class="struct" href="https://doc.rust-lang.org/nightly/std/sync/poison/rwlock/struct.RwLock.html" title="struct std::sync::poison::rwlock::RwLock">RwLock</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="https://docs.rs/log/0.4.25/log/trait.Log.html" title="trait log::Log">Log</a>&gt;&gt;&gt;</code></pre></section></div></main></body></html>
Loading

0 comments on commit b17d889

Please sign in to comment.