Skip to main content

compressed_intvec/
prelude.rs

1// src/prelude.rs
2
3//! A prelude for `compressed-intvec`.
4//!
5//! This prelude is automatically imported when you use `use compressed-intvec::prelude::*;`.
6//! It exports all the most common types and traits.
7
8// --- Fixed-Width Vector Prelude ---
9pub use crate::fixed::{
10    atomic::{AtomicFixedVec, SAtomicFixedVec, UAtomicFixedVec},
11    builder::{FixedVecBuilder, FixedVecFromIterBuilder},
12    iter::{FixedVecIntoIter, FixedVecIter},
13    traits::{Storable as FixedStorable, Word},
14    BEFixedVec, BESFixedVec, BitWidth, Error as FixedVecError, FixedVec, LEFixedVec, LESFixedVec,
15    SFixedVec, UFixedVec,
16};
17
18// --- Variable-Width Vector Prelude ---
19pub use crate::variable::{
20    builder::{VarVecBuilder, VarVecFromIterBuilder},
21    codec::Codec,
22    iter::{VarVecIntoIter, VarVecIter},
23    reader::VarVecReader,
24    seq_reader::VarVecSeqReader,
25    slice::{VarVecSlice, VarVecSliceIter},
26    traits::Storable as VariableStorable,
27    BESVarVec, BEVarVec, LESVarVec, LEVarVec, SVarVec, UVarVec, VarVec, VarVecError,
28};
29
30// Deprecated Variable-Width Vector Aliases (backward compatibility)
31#[allow(deprecated)]
32pub use crate::variable::{
33    BEIntVec, BESIntVec, IntVec, IntVecBuilder, IntVecError, IntVecFromIterBuilder, IntVecIntoIter,
34    IntVecIter, IntVecReader, IntVecSeqReader, IntVecSlice, IntVecSliceIter, LEIntVec, LESIntVec,
35    SIntVec, UIntVec, VariableCodecSpec,
36};
37
38// --- Sequence Vector Prelude ---
39pub use crate::seq::{
40    BESSeqVec, BESeqVec, LESSeqVec, LESeqVec, SSeqVec, SeqIter, SeqVec, SeqVecBuilder, SeqVecError,
41    SeqVecFromIterBuilder, SeqVecIntoIter, SeqVecIter, SeqVecReader, SeqVecSlice, USeqVec,
42};
43
44// --- Macros Prelude ---
45pub use crate::fixed_vec;
46pub use crate::int_vec;
47pub use crate::seq_vec;
48pub use crate::sfixed_vec;
49pub use crate::sint_vec;
50pub use crate::sseq_vec;