qubit-io 0.11.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 item-oriented buffering primitives.
//!
//! This module contains item-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 item windows
//! exposed here.
//!
//! [`BufferedInput`] buffers items in front of an [`crate::Input`] value,
//! implements [`crate::Input`] and [`crate::Seekable`], and exposes the
//! currently unread item window. [`BufferedOutput`] buffers items before an
//! [`crate::Output`] value, implements [`crate::Output`] and
//! [`crate::Seekable`], 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 input and output is
//! [`DEFAULT_BUFFER_CAPACITY`].

mod buffer;
mod buffered_input;
mod buffered_output;

pub use crate::capacity_const::DEFAULT_BUFFER_CAPACITY;
pub use buffer::Buffer;
pub use buffered_input::BufferedInput;
pub use buffered_output::BufferedOutput;