Struct pmd_farc::Farc

pub struct Farc<F: Read + Seek> { /* fields omitted */ }

A parser for a file in the farc format (see the crate root documentation for more information)

Methods

impl<F: Read + Seek> Farc<F>

pub fn new(file: F) -> Result<Self, FarcError>

Create and parse a new Farc object, with the specified input file

pub fn file_count(&self) -> usize

return the number of file contained in this Farc file

pub fn file_count_hashed(&self) -> usize

return the number of file with an unknown name in this Farc file

pub fn file_count_named(&self) -> usize

return the number of file with a known name in this Farc file

pub fn iter_name(&self) -> IntoIter<&String>

iter over the known name of file

pub fn iter_hash(&self) -> IntoIter<u32>

iter over all the hash without an occording known name

pub fn get_named_file(&self, name: &str) -> Result<PartitionMutex<F>, FarcError>

Return an handle to a file stored in this Farc, from it's name. It will hash the name as necessary.

pub fn get_unnamed_file(
    &self,
    hash: u32
) -> Result<PartitionMutex<F>, FarcError>

Return an handle to a file with an unknown name. It won't search for file a known name, as opposed to get_named_file

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

Check if the file name correspond to an hash. If it is the case, it replace the hash with name.

pub fn check_file_name_iter<T: Iterator<Item = String>>(&mut self, iter: T)

Call check_file_name repeteatelly with an iterator

Trait Implementations

impl<F: Debug + Read + Seek> Debug for Farc<F>

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

Formats the value using the given formatter.