Struct MmapIndex 

pub struct MmapIndex { /* private fields */ }

Zero-copy reader for a mmap’d layer sidecar index.

Immutable after construction. The mmap region is PROT_READ | MAP_PRIVATE, so this is Send + Sync.

Implementations

impl MmapIndex

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

Open and validate a sidecar index file.

Returns None if the file doesn’t exist, is too small, or fails any validation check (magic, version, checksum, size consistency).

pub fn dir_records(&self) -> &[DirRecord]

Get the directory records table (sorted by path).

pub fn get_str(&self, off: u32, len: u16) -> &[u8]

Get a string from the string pool by offset and length.

pub fn find_dir(&self, path: &[u8]) -> Option<(usize, &DirRecord)>

Find a directory by path. Returns (index, &DirRecord).

Binary search on the sorted directory table.

pub fn find_entry<'a>( &'a self, dir: &DirRecord, name: &[u8], ) -> Option<&'a EntryRecord>

Find an entry within a directory by name.

Binary search on the entry slice for this directory.

pub fn dir_entries(&self, dir: &DirRecord) -> &[EntryRecord]

Get the contiguous entry slice for a directory.

pub fn is_opaque(&self, dir: &DirRecord) -> bool

Check if a directory is opaque.

pub fn has_whiteout(&self, dir: &DirRecord, name: &[u8]) -> bool

Check if a name is whited out in a directory.

pub fn tombstone_names<'a>(&'a self, dir: &DirRecord) -> TombstoneIter<'a>

Iterate overflow tombstone names for a directory.

pub fn hardlink_refs(&self) -> &[HardlinkRef]

Get the hardlink reference table.

pub fn find_aliases(&self, ino: u64) -> &[HardlinkRef]

Find all aliases of a hardlinked file by host inode number.

pub fn hardlink_path(&self, href: &HardlinkRef) -> &[u8]

Get a hardlink ref’s path string.

Trait Implementations

impl Drop for MmapIndex

fn drop(&mut self)

Executes the destructor for this type.

impl Send for MmapIndex

impl Sync for MmapIndex