Struct Reader 

pub struct Reader {
    pub header: Header,
    /* private fields */
}

Index reader — mmaps the shard file for zero-copy lookups.

Fields

header: Header

Parsed shard header containing section offsets and sizes.

Implementations

impl Reader

pub fn open(path: &Path) -> Result<Self>

Open and memory-map an index file for reading.

Errors

Returns an error if the file cannot be opened, memory-mapped, or its header is invalid.

pub fn get_last_modified(root: &Path) -> Result<u64>

Get the last modification time among all source files in the tree.

Errors

Returns an error if the directory walk fails or metadata cannot be read.

pub fn get_trigram(&self, trigram: Trigram) -> Option<TrigramInfo>

Binary search the trigram table. Returns None if the trigram is unknown.

When CDX compression is active, performs a two-level search: first on the block index, then within the decompressed block.

pub fn decode_postings(&self, info: &TrigramInfo) -> Result<PostingList>

Decode the posting list for a given trigram info.

Errors

Returns an error if the posting data is out of bounds or corrupted.

pub fn get_file(&self, file_id: u32) -> Result<FileInfo>

Retrieve file metadata by its ID.

Errors

Returns an error if the file ID is out of bounds or the file table entry is malformed.

pub fn bloom_may_contain(&self, file_id: u32, trigram: Trigram) -> bool

Check if a bloom filter for a file may contain a trigram.

Returns true if the trigram may be present (conservative) or if any error occurs reading the bloom data (safe default: assume present).

pub const fn metadata(&self) -> ShardMetadata

Retrieve high-level shard metadata without parsing the full header.

pub fn is_stale(&self, path: &Path) -> bool

Detect whether the shard file on disk has been rebuilt under this live mmap.

Returns true if the inode or file size differs, or if the file no longer exists. A stale reader should be dropped and reopened.

On Unix: uses inode comparison (inode changes on atomic rename). On non-Unix: uses file size comparison only (Windows file locking prevents rebuild under live mmap, so size-only detection is sufficient).