Struct ntfs::structured_values::NtfsIndexAllocation

pub struct NtfsIndexAllocation<'n, 'f> { /* private fields */ }

Structure of an $INDEX_ALLOCATION attribute.

This attribute describes the sub-nodes of a B-tree. The top-level nodes are managed via NtfsIndexRoot.

NTFS uses B-trees for describing directories (as indexes of NtfsFileNames), looking up Object IDs, Reparse Points, and Security Descriptors, to just name a few.

An $INDEX_ALLOCATION attribute can be resident or non-resident.

Reference: https://flatcap.github.io/linux-ntfs/ntfs/attributes/index_allocation.html

Implementations

impl<'n, 'f> NtfsIndexAllocation<'n, 'f>

pub fn record_from_vcn<T>( &self, fs: &mut T, index_record_size: u32, vcn: Vcn ) -> Result<NtfsIndexRecord>where T: Read + Seek,

Returns the NtfsIndexRecord located at the given Virtual Cluster Number (VCN).

The record is fully read, fixed up, and validated.

This function is usually called on the return value of NtfsIndexEntry::subnode_vcn to move further down in the B-tree.

pub fn records(&self, index_record_size: u32) -> NtfsIndexRecords<'n, 'f>

Returns an iterator over all Index Records of this $INDEX_ALLOCATION attribute (cf. NtfsIndexRecord).

Each Index Record is fully read, fixed up, and validated.

Trait Implementations

impl<'n, 'f> Clone for NtfsIndexAllocation<'n, 'f>

fn clone(&self) -> NtfsIndexAllocation<'n, 'f>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'n, 'f> Debug for NtfsIndexAllocation<'n, 'f>

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

Formats the value using the given formatter.

impl<'n, 'f> NtfsStructuredValue<'n, 'f> for NtfsIndexAllocation<'n, 'f>

const TY: NtfsAttributeType = NtfsAttributeType::IndexAllocation

fn from_attribute_value<T>( _fs: &mut T, value: NtfsAttributeValue<'n, 'f> ) -> Result<Self>where T: Read + Seek,

Create a structured value from an arbitrary NtfsAttributeValue.