Expand description
Public API for the wireframe library.
This crate provides building blocks for asynchronous binary protocol servers, including routing, middleware, and connection utilities.
Public API discovery is tiered:
- Root exports stay intentionally small and stable.
- Domain modules hold detailed APIs (
app,server,client, and so on). preludeoffers optional convenience imports for common workflows.
Re-exports§
pub use error::Result;pub use error::WireframeError;
Modules§
- app
- Application builder and supporting types.
- app_
data_ store - Concurrent type-erased application data store for shared state.
- byte_
order - Helpers for explicit network byte-order conversions.
- client
- Client runtime for wireframe connections.
- codec
- Pluggable framing codecs for wire protocols.
- connection
- Connection actor responsible for outbound frames.
- correlation
- Traits for working with correlation identifiers on frames.
- error
- Canonical error and result types for the crate.
- extractor
- Extractor and request context definitions.
- fragment
- Fragment metadata primitives for transparent message splitting.
- frame
- Frame encoding utilities and length-prefix helpers built around
tokio_util::codec::LengthDelimitedCodec(4-byte big-endian by default). - hooks
- Internal protocol hooks invoked by the connection actor.
- message
- Message trait and serialization helpers.
- message_
assembler - Protocol-level message assembly hooks.
- metrics
- Metric helpers for
wireframe. - middleware
- Request middleware building blocks.
- panic
- Utilities for formatting panic payloads.
- preamble
- Connection preamble encoding and decoding utilities.
- prelude
- Optional convenience imports for common Wireframe workflows.
- push
- Prioritized queues used for asynchronously pushing frames to a connection.
- request
- Request metadata and streaming body types for handler consumption.
- response
- Response and error types for handler outputs.
- rewind_
stream - Async stream adapter that replays leftover bytes.
- serializer
- Message serialization traits.
- server
- Tokio-based server for
WireframeAppinstances. - session
- Registry of active connection push handles.
- testkit
- Optional test utilities for downstream protocol crates.