Struct playdate_fs::file::File

pub struct File<Api: Api = Default>(/* private fields */);

Implementations

impl File<Default>

pub fn options() -> impl OpenOptions + FileOptionsExt

Creates a blank new set of options ready for configuration. All options are initially set to false.

It is equivalent to FileOptions::new().

impl<Api: Api> File<Api>

pub fn open<P: AsRef<Path>>( path: P, data_dir: bool ) -> Result<File<Api>, ApiError>where Api: Default,

Attempts to open a file in read-only mode.

See the OpenOptions::open method and official docs for more details.

Equivalent to sys::ffi::playdate_file::open

pub fn open_with<P: AsRef<Path>>( api: Api, path: P, data_dir: bool ) -> Result<File<Api>, ApiError>

Attempts to open a file in read-only mode, using the given api.

See the OpenOptions::open method and official docs for more details.

Equivalent to sys::ffi::playdate_file::open

pub fn read(&mut self, to: &mut Vec<u8>, len: c_uint) -> Result<c_uint, Error>

Reads up to len bytes from the file into the buffer buf.

Returns the number of bytes read (0 indicating end of file).

Equivalent to sys::ffi::playdate_file::read

pub fn write(&mut self, from: &[u8]) -> Result<c_uint, Error>

Writes the buffer of bytes buf to the file.

Returns the number of bytes written.

Equivalent to sys::ffi::playdate_file::write

pub fn flush(&mut self) -> Result<c_uint, Error>

Flushes the output buffer of file immediately.

Returns the number of bytes written.

Equivalent to sys::ffi::playdate_file::flush

pub fn tell(&mut self) -> Result<c_uint, Error>

Returns the current read/write offset in the given file handle.

Equivalent to sys::ffi::playdate_file::tell

pub fn seek(&mut self, pos: SeekFrom) -> Result<(), Error>

Sets the read/write offset in the file to pos.

Equivalent to sys::ffi::playdate_file::seek

pub fn close(self) -> Result<(), Error>

Closes this file.

Equivalent to sys::ffi::playdate_file::close

Trait Implementations

impl<Api: Api> AsRaw for File<Api>

type Type = c_void

unsafe fn as_raw(&self) -> *mut Self::Type

This method ia actually safe. Unsafety is because so we’re removing owners lifetime that used by some API parts.

impl<Api: Debug + Api> Debug for File<Api>

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

Formats the value using the given formatter.

impl<Api: Api> Drop for File<Api>

fn drop(&mut self)

Executes the destructor for this type.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.