Struct playdate :: fs :: prelude :: File Copy item path

impl File

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> File<Api>
where Api: Api,

pub fn open(path: P, data_dir: bool) -> Result<File<Api>, Error<Error>>
where P: AsRef<str>, 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( api: Api, path: P, data_dir: bool ) -> Result<File<Api>, Error<Error>>
where P: AsRef<str>,

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: u32) -> Result<u32, 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<u32, 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<u32, 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<u32, 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> AsRaw for File<Api>
where Api: Api,

type Type = c_void

unsafe fn as_raw(&self) -> *mut <File<Api> as AsRaw>::Type

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

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

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

Formats the value using the given formatter. Read more

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

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

impl<Api> UnwindSafe for File<Api>
where Api: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.