qubit-io 0.7.0

Byte-stream buffering and std::io utilities for Rust
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
32
33

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Shared byte-stream buffering primitives.
//!
//! This module contains byte-oriented buffering types used by higher-level
//! stream adapters. It does not know about binary codecs, text encodings, or
//! record formats; callers compose those concerns on top of the byte windows
//! exposed here.
//!
//! [`BufferedByteInput`] buffers bytes in front of a [`std::io::Read`] value,
//! implements [`std::io::BufRead`], and exposes the currently unread byte
//! window. [`BufferedByteOutput`] buffers bytes before a [`std::io::Write`]
//! value and exposes spare writable capacity for hot-path encoders. [`Buffer`]
//! is the low-level position/limit storage object shared by both
//! implementations.
//!
//! The default capacity used by buffered byte input and output is
//! [`DEFAULT_BUFFER_CAPACITY`].

mod buffer;
mod buffered_byte_input;
mod buffered_byte_output;
mod capacity;

pub use buffer::Buffer;
pub use buffered_byte_input::BufferedByteInput;
pub use buffered_byte_output::BufferedByteOutput;
pub use capacity::DEFAULT_BUFFER_CAPACITY;