Struct RomFs

pub struct RomFs<R: Read + Seek> { /* private fields */ }

RomFS representation

Implementations

impl<R: Read + Seek> RomFs<R>

pub const INVALID_ENTRY: u32 = 4_294_967_295u32

Magic value for invalid entry offsets

pub const ROOT_DIR_OFFSET: u32 = 0u32

Offset of the root directory

pub fn from_reader(reader: R) -> Result<Self, Error>

Create a new RomFS parser from a reader

pub fn list_files(&mut self) -> Result<Vec<FileEntry>, Error>

pub fn find_dir(&mut self, path: &str) -> Result<u32, Error>

Find a directory by its path

pub fn get_file_by_path( &mut self, path: &str, ) -> Result<Option<FileEntry>, Error>

Find a file by its path

pub fn file_exists(&mut self, path: &str) -> bool

Check if a file exists by path

pub fn dir_exists(&mut self, path: &str) -> bool

Check if a directory exists by path

pub fn read_to_vec(&mut self, path: &str) -> Result<Option<Vec<u8>>, Error>

Read a file from the RomFS to a Vec

pub fn open_dir( &mut self, path: &str, ) -> Result<RomFsDirectoryIterator<R>, Error>

where Self: Clone, R: Clone,

Open a directory iterator for browsing directories and files

impl<R: Read + Seek + Clone> RomFs<R>

pub fn into_shared(self) -> Result<RomFs<SharedReader<R>>, Error>

Convert this RomFS to use a shared reader

impl<R: Read + Seek> RomFs<SharedReader<R>>

pub fn from_shared(reader: SharedReader<R>) -> Result<Self, Error>

Create a new RomFS parser from a shared reader

Trait Implementations

impl<R: Read + Seek + Clone> Clone for RomFs<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug + Read + Seek> Debug for RomFs<R>

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

Formats the value using the given formatter.

impl<R: Read + Seek + Clone> VirtualFSExt<R> for RomFs<R>

type Entry = FileEntry

fn list_files(&self) -> Result<Vec<Self::Entry>, Error>

List files in the archive

fn get_file(&self, name: &str) -> Result<Option<Self::Entry>, Error>

Get a file by name

fn create_reader(&mut self, file: &Self::Entry) -> Result<SubFile<R>, Error>

Create a SubFile reader for a given file entry