Skip to main content

FileSystem

Struct FileSystem 

Source
pub struct FileSystem { /* private fields */ }
Expand description

VirtualPathFileSystem implementation backed by an MPQ archive.

The Storage must outlive this object — MpqFileSystem holds a non-owning reference to it.

Path separators: both ‘/’ and ‘\’ are accepted and treated identically. Filename comparison is case-insensitive, matching MPQ archive semantics.

Requires the whiteout_mpq CMake target.

Example: auto storage = mpq::Storage::open(“War3.mpq”); utils::MpqFileSystem fs(*storage); auto data = fs.readFile(“units\orc\grunt\grunt.mdx”);

Implementations§

Source§

impl FileSystem

Source

pub fn read_file(&self, path: &str) -> Bytes

Read a file from the archive. Returns an empty vector if not found.

Source

pub fn write_file(&mut self, path: &str, data: &[u8]) -> bool

Write a file into the archive overlay. Changes are not persisted to disk until storage.save() is called on the underlying Storage.

Source

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

Check if a file exists in the archive (including the write overlay).

Trait Implementations§

Source§

impl Debug for FileSystem

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for FileSystem

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Send for FileSystem

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.