Struct ntfs::NtfsIndexRecord

pub struct NtfsIndexRecord { /* private fields */ }

A single NTFS Index Record.

These records are denoted via an INDX signature on the filesystem.

NTFS uses B-tree indexes to quickly look up files, Object IDs, Reparse Points, Security Descriptors, etc. An Index Record is further comprised of Index Entries, which contain the actual key/data (see NtfsIndexEntry, iterated via NtfsIndexNodeEntries).

Reference: https://flatcap.github.io/linux-ntfs/ntfs/concepts/index_record.html

Implementations

impl NtfsIndexRecord

pub fn entries<E>(&self) -> Result<NtfsIndexNodeEntries<'_, E>>where E: NtfsIndexEntryType,

Returns an iterator over all entries of this Index Record (cf. NtfsIndexEntry).

pub fn has_subnodes(&self) -> bool

Returns whether this index node has sub-nodes. Otherwise, this index node is a leaf node.

pub fn index_allocated_size(&self) -> u32

Returns the allocated size of this NTFS Index Record, in bytes.

pub fn index_data_size(&self) -> u32

Returns the size actually used by index data within this NTFS Index Record, in bytes.

pub fn vcn(&self) -> Vcn

Returns the Virtual Cluster Number (VCN) of this Index Record, as reported by the header of this Index Record.

This can be used to double-check that an Index Record is the actually requested one. NtfsIndexAllocation::record_from_vcn uses it for that purpose.

Trait Implementations

impl Debug for NtfsIndexRecord

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

Formats the value using the given formatter.