Repository navigation
1.3 Crate Exports and Module Map
Wiki Keeper (Grok Bot) edited this page Oct 16, 2026
·
3 revisions
Public surface defined in src/lib.rs at tip 08d2f28 (#55).
| 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"]).
- 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 insrc/lib.rs - Traits:
IpcBackend,HybridFlowBackend,BackendFactory,BackendType, deprecatedRuntimeBackend - Backends:
RustBackend; withzmq:ZmqIpcBackend, deprecatedZmqRuntimeBackend, plusZmqMessagePublisher,ZmqMessageSubscriber,ZmqTransportConfig,ZmqHybridFlowBackend,ZmqMessageError,FramingFault,STRUCTURED_MAX_FRAME_BYTES - Validation:
ProtocolLimits,Validate,ValidationError,ValidationKind,ValidationMeasure
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"]
- Home
- 1. Overview
- 1.1. Getting Started
- 1.2. Architecture Overview
- 1.3. Crate Exports and Module Map
- 2. Core Abstractions
- 2.1. IpcBackend Trait
- 2.2. HybridFlowBackend Trait
- 2.3. BackendFactory and BackendType
- 2.4. Error Handling
- 3. Backend Implementations
- 3.1. RustBackend
- 3.2. ZmqIpcBackend
- 3.3. ZMQ Readout Parsing and Golden Frames
- 3.4. Structured ZeroMQ IpcMessage Transport
- 4. IPC Protocol and Data Models
- 4.1. IpcMessage Protocol
- 4.2. Batch Data Types
- 4.3. NeuromodulatorSnapshot and Neuromodulator Packet
- 4.4. StimulusBatch and Runtime Ingress
- 4.5. Deserialization Hooks and Model Compat Aliases
- 5. Validation and Wire Compatibility
- 5.1. Validation Framework and ProtocolLimits
- 5.2. ValidationError and ValidationKind
- 5.3. WireCompatibility and Envelope Decoding
- 5.4. Canonical Wire-v1 Encoding
- 6. corpus_ipc_server HTTP Server
- 6.1. REST API Endpoints
- 6.2. Server Configuration and Deployment
- 7. Build, Dependencies, and Quality Gates
- 7.1. Cargo Features and Dependency Isolation
- 7.2. Testing Strategy
- 7.2.1. Wire-v1 Golden Test Vectors
- 7.2.2. Property-Based Wire Tests
- 7.3. CI, Coverage, and Release Qualification
- 8. Project History and Licensing
- 8.1. Naming History and Completed Renames
- 8.2. Licensing
- 9. Glossary