Skip to content

1.3 Crate Exports and Module Map

Wiki Keeper (Grok Bot) edited this page Oct 16, 2026 · 3 revisions

Crate Exports and Module Map

Public surface defined in src/lib.rs at tip 08d2f28 (#55).

Modules

Module cfg Role
canonical_ser always (crate-private) f32→f64 serde helpers for canonical encode
compatibility always Wire envelope, classify/accept, decode, encode_canonical_ipc_message
error always BackendError, ProtocolError
models always Wire payload types
rust_backend always RustBackend
server feature = "server" router, AppState, REST handlers
trait_def always IpcBackend, HybridFlowBackend, factory
validation always ProtocolLimits, Validate, errors
zmq_backend feature = "zmq" ZmqIpcBackend (binary readout)
zmq_readout feature = "zmq" parse_readout_packet, float cap
zmq_message feature = "zmq" structured IpcMessage PUB/SUB + ZmqHybridFlowBackend

Binary: src/bin/corpus_ipc_server.rs (required-features = ["server"]).

Root re-exports (high level)

  • Compatibility: WireCompatibility, WireEnvelope, Compatibility*, EnvelopeError, SupportedWireVersion, CanonicalEncodeError, accept_wire_version, classify_wire_version, decode_ipc_message_json, decode_ipc_message_value, encode_ipc_message_json, encode_canonical_ipc_message
  • Errors: BackendError, ProtocolError
  • Models: IpcMessage, batch/snapshot types listed in src/lib.rs
  • Traits: IpcBackend, HybridFlowBackend, BackendFactory, BackendType, deprecated RuntimeBackend
  • Backends: RustBackend; with zmq: ZmqIpcBackend, deprecated ZmqRuntimeBackend, plus ZmqMessagePublisher, ZmqMessageSubscriber, ZmqTransportConfig, ZmqHybridFlowBackend, ZmqMessageError, FramingFault, STRUCTURED_MAX_FRAME_BYTES
  • Validation: ProtocolLimits, Validate, ValidationError, ValidationKind, ValidationMeasure

Feature topography

flowchart TD
  Manifest["Cargo.toml features"] --> Default["default empty"]
  Manifest --> ZmqFeat["zmq"]
  Manifest --> ServerFeat["server"]
  Default --> Core["models + RustBackend + compatibility + validation + ProtocolError"]
  ZmqFeat --> ZmqMods["zmq_backend + zmq_readout"]
  ZmqFeat --> ZmqMsg["zmq_message publisher/subscriber/hybrid"]
  ServerFeat --> ServerMod["server module + corpus_ipc_server binary"]
  ServerFeat --> Axum["axum 0.8 + tokio"]
Loading

Clone this wiki locally