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 🔒
- Arrow
Label 🔒 - Back
Edge 🔒Plan - Bezier
Segment 🔒 - Cell
Line 🔒 - CuCompact
String - CuError
- Common copper Error type.
- CuMsg
Origin - Origin metadata captured when a Copper-aware transport receives a remote message.
- Detour
Label 🔒Slot - Duration
Stats 🔒 - Edge
Group 🔒Key - Edge
LogStats 🔒 - Edge
Stats 🔒Key - Interconnect
Render 🔒 - Legend
Metrics 🔒 - LogStats 🔒
- LogStats
Index 🔒 - Node
Bounds 🔒 - Node
Render 🔒 - Null
Backend 🔒 - Observed
Writer - A bincode writer wrapper that reports every encoded byte to Copper’s observation counters.
- Perf
Stats 🔒 - Placed
Section 🔒 - Port
Anchor 🔒Collector - Render
Edge 🔒 - Resource
Owner 🔒 - Resource
Table 🔒 - Section
Layout 🔒 - Section
Ref 🔒 - Straight
Label 🔒Slot - SvgWriter 🔒
- Table
Cell 🔒 - Table
Renderer 🔒 - Task
Output Spec - Trait to trace back from the CopperList the origin of each message slot.
Enums§
- Font
Family 🔒 - Render
Input 🔒 - Resource
Usage 🔒 - Table
Node 🔒 - Text
Align 🔒 - Unified
LogType - Defines the types of what can be logged in the unified logger.
Constants§
- BACKGROUND_
COLOR 🔒 - BACK_
EDGE_ 🔒DUP_ SPACING - BACK_
EDGE_ 🔒NODE_ GAP - BACK_
EDGE_ 🔒SPAN_ EPS - BACK_
EDGE_ 🔒STACK_ SPACING - BORDER_
COLOR 🔒 - BOX_
SHAPE_ 🔒PADDING - BRIDGE_
HEADER_ 🔒BG - CELL_
LINE_ 🔒SPACING - CELL_
PADDING 🔒 - CLUSTER_
COLOR 🔒 - CLUSTER_
MARGIN 🔒 - COMPACT_
STRING_ CAPACITY - CONFIG_
FONT_ 🔒SIZE - CONFIG_
WRAP_ 🔒WIDTH - COPPER_
GITHUB_ 🔒URL - COPPER_
LINK_ 🔒COLOR - COPPER_
LOGO_ 🔒SVG - DETOUR_
LABEL_ 🔒CLEARANCE - DIM_
GRAY 🔒 - EDGE_
COLOR_ 🔒ORDER - EDGE_
COLOR_ 🔒PALETTE - EDGE_
FONT_ 🔒SIZE - EDGE_
HITBOX_ 🔒OPACITY - EDGE_
HITBOX_ 🔒STROKE_ WIDTH - EDGE_
HOVER_ 🔒POINT_ RADIUS - EDGE_
HOVER_ 🔒POINT_ STROKE_ WIDTH - EDGE_
LABEL_ 🔒FIT_ RATIO - EDGE_
LABEL_ 🔒HALO_ WIDTH - EDGE_
LABEL_ 🔒LIGHTEN - EDGE_
LABEL_ 🔒OFFSET - EDGE_
PORT_ 🔒HANDLE - EDGE_
STUB_ 🔒LEN - EDGE_
STUB_ 🔒MIN - EDGE_
TOOLTIP_ 🔒CSS - FONT_
FAMILY 🔒 - FONT_
SIZE 🔒 - GRAPH_
MARGIN 🔒 - HEADER_
BG 🔒 - INTERCONNECT_
EDGE_ 🔒COLOR - INTERMEDIATE_
X_ 🔒EPS - LAYOUT_
SCALE_ 🔒X - LAYOUT_
SCALE_ 🔒Y - LEGEND_
BOTTOM_ 🔒PADDING - LEGEND_
CORNER_ 🔒RADIUS - LEGEND_
FONT_ 🔒SIZE - LEGEND_
ITEMS 🔒 - LEGEND_
LINK_ 🔒GAP - LEGEND_
LOGO_ 🔒SIZE - LEGEND_
PADDING 🔒 - LEGEND_
ROW_ 🔒GAP - LEGEND_
SECTION_ 🔒GAP - LEGEND_
SWATCH_ 🔒SIZE - LEGEND_
TEXT_ 🔒WIDTH_ FACTOR - LEGEND_
TITLE_ 🔒SIZE - LEGEND_
VERSION_ 🔒GAP - LEGEND_
WITH_ 🔒LOGO_ GAP - LIGHT_
GRAY 🔒 - LINUX_
RESOURCE_ 🔒SLOT_ NAMES - LOGSTATS_
SCHEMA_ 🔒VERSION - MODULE_
SEPARATOR 🔒 - MODULE_
TRUNC_ 🔒MARKER - MONO_
FONT_ 🔒FAMILY - OUTER_
BORDER_ 🔒WIDTH - PERF_
TITLE_ 🔒BG - PLACEHOLDER_
TEXT 🔒 - PORT_
DOT_ 🔒RADIUS - PORT_
HEADER_ 🔒FONT_ SIZE - PORT_
LINE_ 🔒GAP - PORT_
VALUE_ 🔒FONT_ SIZE - RESOURCE_
EXCLUSIVE_ 🔒BG - RESOURCE_
LEGEND_ 🔒ITEMS - RESOURCE_
LEGEND_ 🔒TITLE - RESOURCE_
SHARED_ 🔒BG - RESOURCE_
TABLE_ 🔒GAP - RESOURCE_
TABLE_ 🔒MARGIN - RESOURCE_
TITLE_ 🔒BG - RESOURCE_
UNUSED_ 🔒BG - RESOURCE_
UNUSED_ 🔒TEXT - SECTION_
SPACING 🔒 - SINK_
HEADER_ 🔒BG - SOURCE_
HEADER_ 🔒BG - TASK_
HEADER_ 🔒BG - TOOLTIP_
BG 🔒 - TOOLTIP_
BORDER 🔒 - TOOLTIP_
BORDER_ 🔒WIDTH - TOOLTIP_
FONT_ 🔒SIZE - TOOLTIP_
LINE_ 🔒GAP - TOOLTIP_
OFFSET_ 🔒X - TOOLTIP_
OFFSET_ 🔒Y - TOOLTIP_
PADDING 🔒 - TOOLTIP_
RADIUS 🔒 - TOOLTIP_
TEXT 🔒 - TYPE_
FONT_ 🔒SIZE - TYPE_
WRAP_ 🔒WIDTH - VALUE_
BORDER_ 🔒WIDTH
Traits§
- Copper
List Tuple - A CopperListTuple needs to be encodable, decodable and fixed size in memory.
- CuMsg
Metadata Trait - Key metadata piece attached to every message in Copper.
- CuPayload
RawBytes - Provides per-output raw payload sizes aligned with
ErasedCuStampedDataSet::cumsgsorder. - Erased
CuStamped Data - A generic trait to expose the generated CuStampedDataSet from the task graph.
- Erased
CuStamped Data Set - Trait to get a vector of type-erased CuStampedDataSet This is used for generic serialization of the copperlists
- Matching
Tasks - Metadata
- Represent the minimum set of traits to be usable as Metadata in Copper.
- Payload
Schemas - Trait for providing JSON schemas for CopperList payload types.
- Reflect
- A core trait of
bevy_reflect, used for downcasting to concrete types. - Table
Visitor 🔒 - Write
Stream - Defines a basic write, append only stream trait to be able to log or send serializable objects.
Functions§
- abort_
observed_ encode - Aborts any active observed byte counting session.
- approximate_
path_ 🔒length - assign_
back_ 🔒edge_ offsets - base64_
encode 🔒 - begin_
observed_ encode - Starts observed byte counting for the current encode pass.
- build_
back_ 🔒edge_ path - build_
config_ 🔒rows - Render config entries in a stable order for readability and diffs.
- build_
detour_ 🔒label_ slots - build_
edge_ 🔒hover_ overlay - build_
edge_ 🔒path - build_
edge_ 🔒tooltip_ group - build_
explicit_ 🔒path_ data - build_
graph_ 🔒signature - build_
lane_ 🔒path - build_
loop_ 🔒path - build_
node_ 🔒table - Build the record table for a node and capture port ids for routing.
- build_
path_ 🔒data - build_
perf_ 🔒table - build_
port_ 🔒column - Keep input/output rows aligned and generate stable port identifiers.
- build_
resource_ 🔒table - build_
resource_ 🔒tables - build_
section_ 🔒layout - Convert a config graph into positioned nodes, edges, and port anchors.
- build_
sections 🔒 - Normalize mission selection into a list of sections to render.
- build_
straight_ 🔒label_ slots - build_
text_ 🔒node - bundle_
applies 🔒 - cell_
text_ 🔒height - cell_
text_ 🔒size - clamp_
label_ 🔒position - collect_
graph_ 🔒resource_ owners - collect_
node_ 🔒bounds - collect_
port_ 🔒anchors - collect_
resource_ 🔒catalog - colored_
edge_ 🔒style - dedup_
owners 🔒 - detour_
lane_ 🔒bounds_ from_ points - direction_
unit 🔒 - draw_
cluster 🔒 - Visually group rendered sections with a labeled bounding box.
- draw_
created_ 🔒with - draw_
interconnects 🔒 - draw_
legend 🔒 - Render a legend cartridge for task colors and the copper-rs credit line.
- draw_
node_ 🔒table - Draw table cells manually since the layout engine only positions shapes.
- draw_
resource_ 🔒table - edge_
cycle_ 🔒color_ index - edge_
port_ 🔒handle - edge_
stub_ 🔒len - expand_
bounds 🔒 - extend_
max_ 🔒bounds - fallback_
port_ 🔒dirs - find_
horizontal_ 🔒lane_ span - finish_
observed_ encode - Ends observed byte counting and returns the total bytes written.
- fit_
edge_ 🔒label - fit_
label_ 🔒to_ width - flavor_
label 🔒 - flavor_
rank 🔒 - fnv1a64 🔒
- format_
bytes 🔒 - format_
bytes_ 🔒opt - format_
duration_ 🔒ns - format_
duration_ 🔒ns_ f64 - format_
duration_ 🔒ns_ u64 - format_
edge_ 🔒tooltip - format_
endpoint 🔒 - format_
mission_ 🔒list - Keep mission lists stable for consistent error messages.
- format_
none_ 🔒ratio - format_
rate_ 🔒bytes_ per_ sec - format_
rate_ 🔒hz - format_
rate_ 🔒units - format_
resource_ 🔒owners - label_
bbox 🔒 - legend_
text_ 🔒width - lerp_
point 🔒 - lighten_
hex 🔒 - load_
logstats 🔒 - load_
render_ 🔒input - main 🔒
- Render the configuration file to an SVG and optionally opens it with inkscape. CLI entrypoint that parses args, renders SVG, and optionally opens it.
- max_
bottom_ 🔒for_ span - measure_
legend 🔒 - min_
top_ 🔒for_ span - mission_
key 🔒 - normalize_
web_ 🔒color - observed_
encode_ bytes - Returns the number of bytes written so far in the current observed encode pass.
- open_
svg 🔒 - Hide platform-specific open commands behind a single helper.
- parse_
resource_ 🔒path - path_
label_ 🔒anchor - place_
detour_ 🔒label - place_
edge_ 🔒label - place_
label_ 🔒with_ normal - place_
label_ 🔒with_ offset - place_
self_ 🔒loop_ label - port_
dir 🔒 - port_
dir_ 🔒incoming - print_
mission_ 🔒list - Support a CLI mode that prints mission names and exits.
- provider_
resource_ 🔒slots - record_
observed_ encode_ bytes - Records bytes written by an observed writer.
- record_
size 🔒 - Estimate record size before layout so edges and clusters can be sized.
- rects_
overlap 🔒 - render_
config_ 🔒svg - Run the full render pipeline and return SVG bytes for the CLI.
- render_
multi_ 🔒config_ svg - render_
sections_ 🔒to_ svg - Render each section and merge them into a single SVG canvas.
- reorder_
auto_ 🔒input_ rows - reorder_
input_ 🔒rows - resolve_
anchor 🔒 - resolve_
interconnect_ 🔒anchor - resource_
usage 🔒 - resource_
usage_ 🔒color - scale_
layout_ 🔒positions - segment_
length 🔒 - segment_
point 🔒 - shorten_
module_ 🔒path - span_
has_ 🔒intermediate - split_
long_ 🔒token - split_
type_ 🔒tokens - straight_
segment 🔒 - strip_
type_ 🔒params - svg_
data_ 🔒uri - table_
to_ 🔒record - Adapt our table tree into the layout-rs record format.
- tooltip_
anchor_ 🔒for_ path - tooltip_
line_ 🔒height - truncate_
label_ 🔒left - validate_
mission_ 🔒arg - Fail fast on invalid mission ids and provide a readable list.
- visit_
table 🔒 - Walk table cells to compute positions and collect port anchors.
- with_
cause - Creates a CuError with a message and cause in a single call.
- wrap_
text 🔒 - wrap_
type_ 🔒label
Type Aliases§
Derive Macros§
- Reflect
- The main derive macro used by
bevy_reflectfor deriving itsReflecttrait.