Struct MtFile 

pub struct MtFile;

MT Framework’s file stream class (MtFile).

Wraps a game-side file object, exposing its I/O operations — open, read, write, seek and the various size/position queries — through the underlying vtable. Instances are created through the game’s own factory (see open), which is why the type derives CacheDti to locate its MtDti.

MtFile also implements core::fmt::Write, so it can be used as the target of write! / writeln! to append UTF-8 text.

Layout

#[repr(C)] (an opaque, vtable-only type via #[derive(Object)]), since it is only ever used by reference to call its virtual functions.

Implementations

impl MtFile

pub fn open(path: &str, mode: OpenMode) -> MtResult<&mut Self>

Opens the file at path with the given OpenMode.

Locates the MtFile class, constructs a new instance through its factory, and opens the file on it. The path is passed to the game as a raw byte pointer.

Errors

Returns MtError::DtiNotFound if the MtFile class is missing, MtError::FailedToCreateInstance if construction fails, or MtError::FailedToOpenFile if the open itself fails.

pub fn read(&mut self, buffer: &mut [u8]) -> usize

Reads up to buffer.len() bytes into buffer, returning the number of bytes actually read.

pub fn write(&mut self, data: &[u8]) -> usize

Writes data to the file, returning the number of bytes actually written.

pub fn seek(&mut self, offset: isize, origin: Origin)

Moves the file position by offset bytes relative to origin.

pub fn close(&mut self)

pub fn is_async_reading(&self) -> bool

pub fn tell(&self) -> usize

pub fn size(&self) -> usize

pub fn set_size(&mut self, size: usize)

pub fn is_readable(&self) -> bool

pub fn is_writable(&self) -> bool

pub fn is_async_readable(&self) -> bool

pub fn get_async_read_size(&self) -> usize

Trait Implementations

impl CacheDti for MtFile

fn dti() -> Option<&'static MtDti>

Returns the MtDti describing this type’s class, if it exists.

impl HasVtable for MtFile

fn vtable_ptr(&self) -> *const *const c_void

fn get_virtual_function(&self, index: usize) -> *const c_void

impl Object for MtFile

fn dtor(&mut self)

Runs the destructor on self

fn destroy(&mut self)

Runs the destructor on self and deallocates the object

fn create_ui(&self)

Invokes the object’s UI-creation virtual function (vtable slot 2).

fn is_enable_instance(&self) -> bool

Returns whether the object is currently an enabled instance (vtable slot 3).

fn create_property(&self, props: *mut c_void)

Populates props (an MtPropertyList) with the object’s reflected properties (vtable slot 4).

fn get_dti(&self) -> *const c_void

Returns a raw pointer to the object’s MtDti (vtable slot 5).

impl Write for MtFile

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.