bcp-decoder 0.1.0

Streaming decoder for the Bit Context Protocol binary format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

#![warn(clippy::pedantic)]

//! BCP decoder — parses binary payloads into typed blocks.
//!
//! Two APIs are provided:
//!
//! - [`BcpDecoder`] — synchronous, operates on a complete `&[u8]` slice.
//! - [`StreamingDecoder`] — asynchronous, reads from any `AsyncRead` source
//!   and yields blocks incrementally. Requires the `streaming` feature (enabled
//!   by default).
//!
//! **Compression and streaming**: The streaming decoder provides true
//! incremental parsing for uncompressed and per-block-compressed payloads.
//! However, whole-payload compression (`HeaderFlags::COMPRESSED`) forces
//! the streaming decoder to buffer the entire payload before yielding
//! blocks — the streaming API surface is preserved but the memory and
//! latency benefits are lost. Prefer per-block compression when streaming
//! matters.

pub mod block_reader;
pub mod decoder;
pub mod error;
#[cfg(feature = "streaming")]
pub mod streaming;

mod decompression;

pub use decoder::{DecodedPayload, BcpDecoder};
pub use error::DecodeError;
#[cfg(feature = "streaming")]
pub use streaming::{DecoderEvent, StreamingDecoder};