Struct Header 

pub struct Header {

    pub version_major: u16,
    pub version_minor: u16,
    pub flags: u64,
    pub created_at: u64,
    pub source_bytes_total: u64,
    pub file_count: u32,
    pub trigram_count: u32,
    pub file_table_offset: u64,
    pub file_table_size: u64,
    pub trigram_table_offset: u64,
    pub trigram_table_size: u64,
    pub posting_data_offset: u64,
    pub posting_data_size: u64,
    pub bloom_offset: u64,
    pub bloom_size: u64,
    pub string_pool_offset: u64,
    pub string_pool_size: u64,
    pub name_index_offset: u64,
    pub name_index_size: u64,
    pub cdx_block_index_offset: u64,
    pub cdx_block_index_size: u64,
}

Parsed contents of the fixed 256-byte index header.

All integer fields are stored little-endian in the file. Offsets are absolute byte offsets from the start of the file.

Fields

version_major: u16

Format major version (must equal VERSION_MAJOR).

version_minor: u16

Format minor version (must be ≥ VERSION_MINOR).

flags: u64

Bit-field of feature flags (see flags).

created_at: u64

Unix timestamp (seconds) when the index was created.

source_bytes_total: u64

Sum of byte-sizes of all source files when indexed.

file_count: u32

Number of file entries in the file table.

trigram_count: u32

Number of trigram entries in the trigram table.

file_table_offset: u64

Byte offset to the file table section.

file_table_size: u64

Byte length of the file table section.

trigram_table_offset: u64

Byte offset to the trigram lookup table.

trigram_table_size: u64

Byte length of the trigram lookup table.

posting_data_offset: u64

Byte offset to the posting-list data blob.

posting_data_size: u64

Byte length of the posting-list data blob.

bloom_offset: u64

Byte offset to the bloom-filter section (0 if absent).

bloom_size: u64

Byte length of the bloom-filter section (0 if absent).

string_pool_offset: u64

Byte offset to the string pool section.

string_pool_size: u64

Byte length of the string pool section.

name_index_offset: u64

Byte offset to the file-name index section (0 if absent).

name_index_size: u64

Byte length of the file-name index section (0 if absent).

cdx_block_index_offset: u64

Byte offset to the CDX block index (0 if absent).

cdx_block_index_size: u64

Byte length of the CDX block index (0 if absent).

Implementations

impl Header

pub fn parse(data: &[u8]) -> Result<Self>

Parse header from the first 256 bytes of an index file.

Errors

Returns an error if the data is too small, has a bad magic number, unsupported version, or corrupted CRC.

pub fn validate_bounds(&self, file_len: u64) -> Result<()>

Validate all section offsets fit within the file.

Errors

Returns an error if any section extends beyond the file length.

pub const fn has_bloom(&self) -> bool

Returns true when the index includes per-trigram bloom filters.

pub const fn has_cdx(&self) -> bool

Returns true when the trigram table uses CDX compression.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.