Crate byteor_pipeline_spec

Expand description

ByteOr pipeline specification (contract + validation).

This crate is the stable, deterministic representation of pipeline intent that executors can validate and run.

Structs§

BridgeRoleCfgV1: Bridge role configuration.
EndpointCfgV1: Endpoint configuration.
LaneCfgV1: Lane configuration.
LaneGraphV1: LaneGraph v1 spec: endpoints + lanes + roles over named lanes.
MergeRoleCfgV1: Merge role configuration (fan-in).
RouterRoleCfgV1: Router role configuration.
SingleRingBuilder: Builder for ExecutionModelV1::SingleRing specs.
SingleRingV1: SingleRing v1 spec: a stage DAG executed over one sequenced ring.
SpecError: Validation/decoding errors.
StageRoleCfgV1: Stage role configuration.
StageV1: A single stage in a SingleRing pipeline.

EndpointKindV1: Endpoint direction.
ExecutionModelV1: Execution model for a pipeline.
LaneKindV1: Lane kind (transport/backing substrate).
MergePolicyV1: Merge selection policy.
OnFullV1: Backpressure policy when a lane is full.
OrderingV1: Ordering semantics for a pipeline edge/lane.
PipelineSpecV1: v1 pipeline spec root.
RoleCfgV1: Role configuration.
ShardKeyV1: Deterministic shard-key extraction for PerKey sharding.
SingleRingProducerV1: Producer model requested for a SingleRing pipeline.
SingleRingSchedulingV1: Scheduling/consumption model requested for a SingleRing pipeline.
StageOpV1: Minimal built-in stage operations.

FANOUT_V1_MAX_CONSUMERS: Maximum fanout width supported by the v1 SHM-backed pipeline runtime.
SEQUENCED_SLOTS_V1_GATING: SequencedSlots v1 gating constant.
SPEC_V1: Spec version.

canonical_encode_kv_v1: Encode a spec using the canonical v1 ordering contract.
canonical_spec_sha256_hex_v1: Return the SHA-256 hex digest of canonical v1 spec bytes.
canonicalize_spec_kv_v1: Canonicalize a v1 spec.kv blob as decode_kv_v1() → validate_v1() → encode_kv_v1().
canonicalize_v1: Return a canonicalized v1 spec with deterministic ordering for semantically unordered fields.
decode_kv_v1: Decode a v1 spec from the stable line-oriented kv format.
describe_v1: Render a stable human-readable description for a v1 spec.
dot_lane_graph_v1: Render a LaneGraph v1 spec as Graphviz DOT.
dot_v1: Render a v1 spec as Graphviz DOT.
encode_kv_v1: Encode a v1 spec into a stable line-oriented kv format.
single_ring_chain: Convenience helper to build a SingleRing chain: stage i depends on stage i-1.
validate_v1: Validate the spec for v1.