Struct pmd_farc::FileNameIndex

pub struct FileNameIndex { /* fields omitted */ }

Represent an index of a FARC file. Each subfile have a known position and lenght related to it’s parent file, as well as the hash of the name. The full name may or may not be known for a file.

Implementations

impl FileNameIndex

pub fn add_file_with_hash(
    &mut self,
    hash: u32,
    offset: u32,
    lenght: u32
) -> Result<(), FileNameError>

Add an entry in this index, with the hash being the crc32 ieee hash of the name encoded as utf16. Return an error if a conflict happen.

pub fn add_file_with_name(
    &mut self,
    name: String,
    offset: u32,
    lenght: u32
) -> Result<(), FileNameError>

Add an entry to this index, with the name being a standard string. It will internally be converted to the good hash using hash_name. Return an error if a conflict happen.

pub fn check_file_name(&mut self, name: &str) -> bool

If a file is found in the index that have a file name hash that correspond to the given name. If it does, return true, and save this name. otherwise, return false.

If there is a conflict found, do nothing and return false

#[must_use]pub fn get_file_by_name(&self, name: &str) -> Option<&FarcFile>

Return the file with the given name (the hash of the name is also tested, but not saved). If there is a conflict with the hash value, None is returned.

#[must_use]pub fn get_file_by_hash(&self, hash: u32) -> Option<&FarcFile>

Return the file with the conresponding file name hash.

#[must_use]pub fn len(&self) -> usize

return the total number of registered file in this index.

#[must_use]pub fn is_empty(&self) -> bool

return true is the this farc archive don’t have any file

pub fn iter(&self) -> impl Iterator<Item = &FarcFile>

iterate over all the file entry, sorted by addition order.

Trait Implementations

impl Debug for FileNameIndex

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

Formats the value using the given formatter.

impl Default for FileNameIndex

fn default() -> FileNameIndex

Returns the “default value” for a type.