Struct nitro_fs::fnt::Directory

pub struct Directory {
    pub path: PathBuf,
    pub files: Vec<FileEntry>,
    // some fields omitted
}

Represents a NitroROM directory.

Notes

path will be the full path relative to the root of the file name table.

value for the root directory is the number of directories in the file name table. For non-root directories, it is the ID of the directory's parent.

Because the root directory has no parent ID value, a parent_id call on the root directory will return ROOT_ID.

Fields

path: PathBuf

Name of the directory

files: Vec<FileEntry>

Implementations

impl Directory

pub fn new<R: Read>(reader: &mut R, id: u16) -> Result<Self, Error>

pub fn set_path<P: AsRef<Path>>(&mut self, path: P)

Sets the full path that this directory is referenced by.

pub fn offset(&self) -> u32

The offset into the FNT where this directory's info is stored.

pub fn id(&self) -> u16

The ID of the directory.

pub fn start_id(&self) -> u16

The ID of the first file in the directory's subtable.

pub fn parent_id(&self) -> u16

The ID of the parent directory.

If this is the root directory, ROOT_ID will be returned instead.

pub fn is_root(&self) -> bool

Whether this directory is the root.

pub fn append_file(&mut self, file: FileEntry)

Appends a file to the file list associated with this directory.

pub fn append_files(&mut self, files: &[FileEntry])

Appends several files to the list associated with this directory.

Trait Implementations

impl Clone for Directory

fn clone(&self) -> Directory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Directory

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

Formats the value using the given formatter.

impl Eq for Directory

impl Hash for Directory

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Directory

fn cmp(&self, other: &Directory) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Directory> for Directory

fn eq(&self, other: &Directory) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Directory) -> bool

This method tests for !=.

impl PartialOrd<Directory> for Directory

fn partial_cmp(&self, other: &Directory) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Directory) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Directory) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Directory) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Directory) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Directory

impl StructuralPartialEq for Directory