Struct SeqVecFromIterBuilder 

pub struct SeqVecFromIterBuilder<T: Storable, E: Endianness, I> { /* private fields */ }

A builder for creating a SeqVec from an iterator of sequences.

This builder is designed for constructing a SeqVec from a data source that produces sequences on the fly. It consumes the iterator in a single pass, compressing sequences as they arrive.

Limitations

This builder does not support:

• Codec::Auto: Automatic codec selection requires analyzing all data, which is impossible in a single pass.
• Parameter estimation for codecs like Rice { log2_b: None } or Zeta { k: None }.

The codec must be fully specified. If an unsupported codec is provided, the build method will return an error.

Examples

use compressed_intvec::seq::{SeqVec, LESeqVec, Codec};

// Generate sequences on the fly
let sequences_iter = (0..100).map(|i| vec![i as u32, i as u32 + 1]);

let vec: LESeqVec<u32> = SeqVec::from_iter_builder(sequences_iter)
    .codec(Codec::Gamma) // Must be specified
    .build()?;

assert_eq!(vec.num_sequences(), 100);

Implementations

impl<T, E, I, S> SeqVecFromIterBuilder<T, E, I>

where T: Storable, E: Endianness, I: IntoIterator<Item = S>, S: AsRef<[T]>,

pub fn new(iter: I) -> Self

Creates a new builder from an iterator with default settings.

The default codec is Codec::Gamma, as automatic selection is not possible in single-pass construction.

pub fn codec(self, codec_spec: Codec) -> Self

Sets the compression codec to use.

The codec must be fully specified (no Auto, no None parameters).

Arguments

• codec_spec - The fully-specified codec to use for encoding.

Errors

The build method will return an error if a codec requiring data analysis is provided.

pub fn store_lengths(self, store: bool) -> Self

Enables or disables storing explicit sequence lengths.

When enabled, the builder stores a compact FixedVec of per-sequence lengths. This allows O(1) length queries and enables faster decoding paths that avoid end-bit checks.

The default is false to minimize memory usage.

pub fn build(self) -> Result<SeqVec<T, E, Vec<u64>>, SeqVecError>

where T: 'static, BufBitWriter<E, MemWordWriterVec<u64, Vec<u64>>>: BitWrite<E, Error = Infallible> + CodesWrite<E>,

Builds the SeqVec by consuming the iterator.

This method streams sequences directly from the iterator without materializing them all in memory. Single-pass construction avoids temporary allocations but requires the codec to be fully specified.

Errors

Returns a SeqVecError if:

• An automatic or parameter-estimating codec spec is used.
• An I/O error occurs during encoding.

Examples

use compressed_intvec::seq::{SeqVec, LESeqVec, Codec};

let sequences: Vec<Vec<u32>> = vec![vec![1, 2], vec![3, 4, 5]];

let vec: LESeqVec<u32> = SeqVec::from_iter_builder(sequences.into_iter())
    .codec(Codec::Delta)
    .build()?;

Trait Implementations

impl<T: Debug + Storable, E: Debug + Endianness, I: Debug> Debug for SeqVecFromIterBuilder<T, E, I>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.