Struct CodecFileWriter 

pub struct CodecFileWriter { /* private fields */ }

Streaming writer for a Level-2 TQCV corpus file.

The file is opened with TQCX (tentative) magic and finalized to TQCV once all records have been written and the count is known.

Implementations

impl CodecFileWriter

pub fn create( path: &Path, config_hash: &str, dimension: u32, bit_width: u8, residual: bool, metadata: &[u8], ) -> Result<Self, IoError>

Create a new TQCV corpus file at path and write the tentative header.

Errors

Returns IoError if the file cannot be created, or if any header field value is invalid.

pub fn append(&mut self, cv: &CompressedVector) -> Result<(), IoError>

Append one CompressedVector as a length-prefixed Level-1 record.

Errors

Returns IoError if the vector cannot be serialized or written.

pub fn finalize(self) -> Result<(), IoError>

Finalize the file: sync body, back-patch vector_count, flip magic to TQCV, sync again.

After calling finalize, the writer is consumed and the file is closed.

Errors

Returns IoError if any seek, write, or sync operation fails.

pub const fn vector_count(&self) -> u64

Number of vectors written so far.

pub fn config_hash(&self) -> &str

Config hash used when creating the file.

pub const fn dimension(&self) -> u32

Dimension declared in the header.

pub const fn bit_width(&self) -> u8

Bit width declared in the header.

pub const fn residual(&self) -> bool

Whether the file was created with the residual flag set.

pub fn body_offset( config_hash: &str, metadata_len: usize, ) -> Result<usize, IoError>

Compute the byte offset of the first record body in the file.

This mirrors the body_offset formula from [encode_header]: the header is padded to an 8-byte boundary after the variable prefix.

Errors

Returns IoError::InvalidHeader if the parameters would produce an invalid header (same constraints as [encode_header]).