Struct ntfs::NtfsIndex

pub struct NtfsIndex<'n, 'f, E>where
    E: NtfsIndexEntryType,{ /* private fields */ }

Helper structure to iterate over all entries of an index or find a specific one.

The E type parameter of NtfsIndexEntryType specifies the type of the index entries. The most common one is NtfsFileNameIndex for file name indexes, commonly known as “directories”. Check out NtfsFile::directory_index to return an NtfsIndex object for a directory without any hassles.

Implementations

impl<'n, 'f, E> NtfsIndex<'n, 'f, E>where E: NtfsIndexEntryType,

pub fn new( index_root_item: NtfsAttributeItem<'n, 'f>, index_allocation_item: Option<NtfsAttributeItem<'n, 'f>> ) -> Result<Self>

Creates a new NtfsIndex object from a previously looked up NtfsIndexRoot attribute (contained in an NtfsAttributeItem) and, in case of a large index, a matching NtfsIndexAllocation attribute (also contained in an NtfsAttributeItem).

If you just want to look up files in a directory, check out NtfsFile::directory_index, which looks up the correct NtfsIndexRoot and NtfsIndexAllocation attributes for you.

pub fn entries<'i>(&'i self) -> NtfsIndexEntries<'n, 'f, 'i, E>

Returns an NtfsIndexEntries iterator to perform an in-order traversal of this index.

pub fn finder<'i>(&'i self) -> NtfsIndexFinder<'n, 'f, 'i, E>

Returns an NtfsIndexFinder structure to efficiently find an entry in this index.

Trait Implementations

impl<'n, 'f, E> Clone for NtfsIndex<'n, 'f, E>where E: NtfsIndexEntryType + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'n, 'f, E> Debug for NtfsIndex<'n, 'f, E>where E: NtfsIndexEntryType + Debug,

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

Formats the value using the given formatter.