Skip to main content

qubit_codec_binary/
lib.rs

1// =============================================================================
2//    Copyright (c) 2026 Haixing Hu.
3//
4//    SPDX-License-Identifier: Apache-2.0
5//
6//    Licensed under the Apache License, Version 2.0.
7// =============================================================================
8
9//! # Qubit Binary Codec
10//!
11//! Buffer-oriented binary codecs for Rust.
12//!
13//! This crate provides fixed-width scalar, LEB128, and ZigZag codecs for
14//! caller-managed byte buffers. Stream-oriented readers and writers live in
15//! `qubit-io-binary`.
16
17mod codec;
18
19#[doc = include_str!("../README.md")]
20#[cfg(doctest)]
21mod readme_examples {}
22
23#[doc = include_str!("../README.zh_CN.md")]
24#[cfg(doctest)]
25mod readme_zh_cn_examples {}
26
27#[doc = include_str!("../doc/user_guide.md")]
28#[cfg(doctest)]
29mod user_guide_examples {}
30
31#[doc = include_str!("../doc/user_guide.zh_CN.md")]
32#[cfg(doctest)]
33mod user_guide_zh_cn_examples {}
34
35pub use codec::BinaryCodec;
36pub use codec::Leb128Codec;
37pub use codec::Leb128DecodeError;
38pub use codec::Leb128DecodeErrorKind;
39pub use codec::Leb128DecodePolicy;
40pub use codec::NonStrict;
41pub use codec::Strict;
42pub use codec::ZigZagCodec;