Struct ggez::filesystem::Filesystem

pub struct Filesystem { /* private fields */ }

A structure that contains the filesystem state and cache.

Implementations

impl Filesystem

pub fn new<P: AsRef<Path>, Q: AsRef<Path>>( id: &str, author: &str, resources_dir_name: P, resources_zip_name: Q ) -> GameResult<Filesystem>

Create a new Filesystem instance, using the given id and (on some platforms) the author as a portion of the user directory path. This function is called automatically by ggez, the end user should never need to call it.

pub fn open<P: AsRef<Path>>(&self, path: P) -> GameResult<File>

Opens the given path and returns the resulting File in read-only mode.

pub fn open_options<P: AsRef<Path>>( &self, path: P, options: OpenOptions ) -> GameResult<File>

Opens a file in the user directory with the given filesystem::OpenOptions. Note that even if you open a file read-write, it can only write to files in the “user” directory.

pub fn create<P: AsRef<Path>>(&self, path: P) -> GameResult<File>

Creates a new file in the user directory and opens it to be written to, truncating it if it already exists.

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

Create an empty directory in the user dir with the given name. Any parents to that directory that do not exist will be created.

pub fn delete<P: AsRef<Path>>(&self, path: P) -> GameResult

Deletes the specified file in the user dir.

pub fn delete_dir<P: AsRef<Path>>(&self, path: P) -> GameResult

Deletes the specified directory in the user dir, and all its contents!

pub fn exists<P: AsRef<Path>>(&self, path: P) -> bool

Check whether a file or directory exists.

pub fn is_file<P: AsRef<Path>>(&self, path: P) -> bool

Check whether a path points at a file.

pub fn is_dir<P: AsRef<Path>>(&self, path: P) -> bool

Check whether a path points at a directory.

pub fn read_dir<P: AsRef<Path>>( &self, path: P ) -> GameResult<Box<dyn Iterator<Item = PathBuf>>>

Returns a list of all files and directories in the resource directory, in no particular order.

Lists the base directory if an empty path is given.

pub fn print_all(&self)

Prints the contents of all data directories to standard output. Useful for debugging.

pub fn log_all(&self)

Outputs the contents of all data directories, using the “info” log level of the log crate. Useful for debugging.

pub fn mount(&self, path: &Path, readonly: bool)

Adds the given (absolute) path to the list of directories it will search to look for resources.

You probably shouldn’t use this in the general case, since it is harder than it looks to make it bulletproof across platforms. But it can be very nice for debugging and dev purposes, such as by pushing $CARGO_MANIFEST_DIR/resources to it

pub fn add_zip_file<R: Read + Seek + 'static>(&self, reader: R) -> GameResult

Adds any object that implements Read + Seek as a zip file.

Note: This is not intended for system files for the same reasons as for .mount(). Rather, it can be used to read zip files from sources such as std::io::Cursor::new(includes_bytes!(...)) in order to embed resources into the game’s executable.

pub fn read_config(&self) -> GameResult<Conf>

Looks for a file named /conf.toml in any resource directory and loads it if it finds it. If it can’t read it for some reason, returns an error.

pub fn write_config(&self, conf: &Conf) -> GameResult

Takes a Conf object and saves it to the user directory, overwriting any file already there.

pub fn resources_dir(&self) -> &Path

Returns the full path to the resource directory (even if it doesn’t exist)

pub fn zip_dir(&self) -> &Path

Get a reference to the filesystem’s zip dir.

pub fn user_config_dir(&self) -> &Path

Return the full path to the user config directory.

pub fn user_data_dir(&self) -> &Path

Return the full path to the user data directory.

Trait Implementations

impl Debug for Filesystem

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

Formats the value using the given formatter.

impl Has<Filesystem> for Context

fn retrieve(&self) -> &Filesystem

Method to retrieve the context type.