Struct SegmentReader 

pub struct SegmentReader { /* private fields */ }

Validated read-only memory mapping with lazy region checksum verification.

Implementations

impl SegmentReader

pub fn open( vfs: &dyn Vfs, path: &Path, expected_id: SegmentId, ) -> Result<Self, SegmentError>

Memory-maps a segment and validates only its bounded header/directory.

pub const fn meta(&self) -> &SegmentMeta

Returns immutable manifest-visible metadata decoded from the header.

pub const fn header_length(&self) -> usize

Returns exact header bytes touched by an O(manifest) open.

pub fn directory(&self) -> &[RegionEntry]

Returns the validated region directory, including unknown skippable kinds.

pub fn unknown_region_ids(&self) -> Vec<u16>

Returns unknown region ids without treating them as corruption.

pub fn region(&self, kind: RegionKind) -> Result<&[u8], SegmentError>

Validates a complete region and returns its original mmap-backed bytes.

pub fn region_chunk( &self, kind: RegionKind, chunk_index: u32, ) -> Result<&[u8], SegmentError>

Validates one 64-KB chunk and returns only that mmap-backed chunk.

pub fn bit4_codes(&self) -> Result<&[u8], SegmentError>

Returns packed Bit4 code bytes exactly as passed to the batch kernel.

pub fn f32_codes(&self) -> Result<&[f32], SegmentError>

Casts validated full-precision code rows directly from the mapping.

pub fn int8_codes(&self) -> Result<&[i8], SegmentError>

Casts signed-byte vector codes directly from the validated mmap region.

pub fn bit4_factors(&self) -> Result<&[Bit4Factors], SegmentError>

Casts the validated factor region directly to permanent Bit4 records.

pub fn int8_factors(&self) -> Result<&[Int8Factors], SegmentError>

Casts a validated Int8 factor region directly to permanent records.

pub fn rescore_f32(&self) -> Result<&[f32], SegmentError>

Casts validated f32 exact-rescore rows directly from the mmap.

pub fn columns(&self) -> Result<ColumnStore, SegmentError>

Decodes the checksummed metadata region into typed column arrays.

A reader from a published snapshot decodes against the collection schema, so columns added after this segment was sealed read as null.

pub fn postings(&self) -> Result<Option<SealedSegment>, SegmentError>

Decodes the optional whole-segment lexical region.

pub fn alive(&self) -> Result<AliveSet, SegmentError>

Decodes the checksummed alive/tombstone region.

pub fn document_version( &self, row: usize, ) -> Result<Option<DocumentVersion>, SegmentError>

Decodes one optional sealed-row document identity directly from the mapping.

pub fn row_for_document_version( &self, version: DocumentVersion, ) -> Result<Option<usize>, SegmentError>

Finds the sealed row that holds exactly version.

None means the segment predates document versions or holds no row with that exact document id and revision.

pub fn stored_metadata( &self, ) -> Result<Option<StoredMetadataRows<'_>>, SegmentError>

Returns validated opaque metadata rows, or None for older segments.

pub fn stored_text(&self) -> Result<Option<StoredTextRows<'_>>, SegmentError>

Returns validated optional UTF-8 source rows, or None for older segments.

Every call verifies the region checksum and walks every row offset.

impl SegmentReader

pub fn graph_node_blocks(&self) -> Result<GraphNodeBlocks<'_>, SegmentError>

Returns the validated, mmap-backed fixed-stride graph node-block region.

pub fn validate_all(&self) -> Result<(), SegmentError>

Validates every region, alignment padding, and the whole-file trailer.