Struct Fs 

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

Playdate File-system API.

Uses inner api end-point for all operations.

Implementations

impl Fs<Default>

pub fn Default() -> Self

Creates default Fs without type parameter requirement.

Uses ZST api::Default.

impl Fs<Cache>

pub fn Cached() -> Self

Creates Fs without type parameter requirement.

Uses api::Cache.

impl<Api: Default + Api> Fs<Api>

pub fn new() -> Self

impl<Api: Api> Fs<Api>

pub fn new_with(api: Api) -> Self

impl<Api: Api> Fs<Api>

pub fn open<P: AsRef<Path>, Opts: OpenOptions>( &self, path: P, options: Opts, ) -> Result<File<Api>, ApiError>

where Api: Copy,

Open file for given options.

Creates new File instance with copy of inner api end-point.

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

pub fn open_with<T: Api, P: AsRef<Path>, Opts: OpenOptions>( &self, api: T, path: P, options: Opts, ) -> Result<File<T>, ApiError>

Open file for given options.

Creates new File instance with given api.

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

pub fn close<T: Api>(&self, file: File<T>) -> Result<(), Error>

Closes the given file.

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

pub fn tell(&self, file: &mut impl AnyFile) -> Result<c_uint, Error>

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

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

pub fn seek_raw( &self, file: &mut impl AnyFile, pos: c_int, whence: Whence, ) -> Result<(), Error>

Sets the read/write offset in the given file to pos, relative to the whence.

• Whence::Start is relative to the beginning of the file,
• Whence::Current is relative to the current position of the file,
• Whence::End is relative to the end of the file.

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

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

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

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

Caution: Vector must be prefilled with 0s.

let mut buf = Vec::<u8>::with_capacity(size);
buf.resize(size, 0);
fs.read(&mut file, &mut buf, size)?;

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

pub fn write( &self, file: &mut impl AnyFile, 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(&self, file: &mut impl AnyFile) -> 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 metadata<P: AsRef<Path>>(&self, path: P) -> Result<FileStat, ApiError>

Populates the FileStat stat with information about the file at path.

Equivalent to sys::ffi::playdate_file::stat

pub fn metadata_to<P: AsRef<Path>>( &self, path: P, metadata: &mut FileStat, ) -> Result<(), ApiError>

Writes into the given metadata information about the file at path.

Equivalent to sys::ffi::playdate_file::stat

pub fn create_dir<P: AsRef<Path>>(&self, path: P) -> Result<(), ApiError>

Creates the given path in the Data/<gameid> folder.

It does not create intermediate folders.

Equivalent to sys::ffi::playdate_file::mkdir

pub fn remove<P: AsRef<Path>>(&self, path: P) -> Result<(), ApiError>

Deletes the file at path. Directory is a file too, definitely.

See also remove_dir_all.

Equivalent to sys::ffi::playdate_file::unlink

pub fn remove_dir_all<P: AsRef<Path>>(&self, path: P) -> Result<(), ApiError>

Deletes the file at path.

If the path is a folder, this deletes everything inside the folder (including folders, folders inside those, and so on) as well as the folder itself.

Equivalent to sys::ffi::playdate_file::unlink

pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>( &self, from: P, to: Q, ) -> Result<(), ApiError>

Renames the file at from to to.

It will overwrite the file at to.

It does not create intermediate folders.

Equivalent to sys::ffi::playdate_file::rename

pub fn read_dir<P, Fn>( &self, path: P, callback: Fn, include_hidden: bool, ) -> Result<(), ApiError>

where P: AsRef<Path>, Fn: FnMut(String),

Calls the given callback function for every file at path.

Subfolders are indicated by a trailing slash ‘/’ in filename.

This method does not recurse into subfolders.

If include_hidden is set, files beginning with a period will be included; otherwise, they are skipped.

Returns error if no folder exists at path or it can’t be opened.

Equivalent to sys::ffi::playdate_file::listfiles

Trait Implementations

impl<Api: Clone> Clone for Fs<Api>

fn clone(&self) -> Fs<Api>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Api: Debug> Debug for Fs<Api>

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

Formats the value using the given formatter.

impl<Api: Default + Api> Default for Fs<Api>

fn default() -> Self

Returns the “default value” for a type.

impl<Api: Copy> Copy for Fs<Api>

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.