tinyquant-io 0.0.0

Serialization, mmap, and file I/O for TinyQuant.
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
34
35
36
37

//! Serialization, mmap, and file I/O for `TinyQuant`.
//!
//! This crate provides:
//!
//! - [`compressed_vector::to_bytes`] — encode a [`tinyquant_core::codec::CompressedVector`]
//!   to the Level-1 binary wire format.
//! - [`compressed_vector::from_bytes`] — decode from the wire format.
//! - [`errors::IoError`] — error type for all I/O operations.
//! - [`zero_copy::CompressedVectorView`] — zero-copy view of a Level-1 record.
//! - [`codec_file`] — Level-2 TQCV corpus file container.
#![deny(
    warnings,
    missing_docs,
    unsafe_op_in_unsafe_fn,
    clippy::all,
    clippy::pedantic,
    clippy::nursery,
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::panic,
    clippy::indexing_slicing,
    clippy::cognitive_complexity
)]
#![allow(clippy::module_name_repetitions, clippy::must_use_candidate)]

pub mod codec_file;
pub mod compressed_vector;
pub mod errors;
#[cfg(feature = "rayon")]
pub mod parallelism;
pub mod zero_copy;

#[cfg(feature = "mmap")]
pub mod mmap;

pub use compressed_vector::{from_bytes, to_bytes};
pub use zero_copy::CompressedVectorView;