Struct HostFilesystem 

pub struct HostFilesystem { /* private fields */ }

A wrapper around interacting with the ‘host’ or PC filesystem for the various times a cat-dev will reach out to the host.

This is little more than a wrapper around a PathBuf, and targeted methods to make getting files/generating default files/etc. easy. Most of the actual logic for turning a request from SDIO, ATAPI, etc. all come from those client/server implementations rather than the logic living here.

Implementations

impl HostFilesystem

pub async fn from_cafe_dir(cafe_dir: Option<PathBuf>) -> Result<Self, FSError>

Create a filesystem from a root cafe dir.

If no cafe dir is provided, we will attempt to locate the default installation path for cafe sdk which is:

• C:\cafe_sdk on windows.
• /opt/cafe_sdk on any unix/bsd like OS.

NOTE: This will validate that all title id paths are lowercase, as files are always expected to be lowercase when dealing with CAFE. Other files are usually kept in the correct naming format. HOWEVER, users may notice spurious errors with case-insensitivity on linux specifically. If transferring an SDK from a Windows/Mac Case Insensitive to a Mac/Linux case sensitive file system. It is recommended users create their own folder using our recovery tools, rather than rsync’ing a path over from case-insensitive, to case-sensitive.

Errors

If the Cafe SDK folder is corrupt, or can’t be found. A Cafe SDK folder is considered corrupt if it is missing core files that we need to be able to serve a Cafe-OS distribution. These file requirements may change from version to version of this crate, but should always be compatible with a clean cafe sdk folder.

pub const fn cafe_sdk_path(&self) -> &PathBuf

The root path to the Cafe SDK.

note: although we do expose this for logging, and other info… we do not recommend manually interacting with the SDK path. There are much better alternatives.

pub fn disc_emu_path(&self) -> PathBuf

The root path to the Cafe SDK.

note: although we do expose this for logging, and other info… we do not recommend manually interacting with the SDK path. There are much better alternatives.

pub fn force_unique_fds(&mut self) -> Result<(), FSEmulAPIError>

Force unique file descriptors for open files.

Certain OS’s can return duplicate fd’s especially when opening, and closing files. This can make deciphering logs harder because the same FD may appear multiple times, when you’re trying to just find the logs related to one file descriptor.

When unique fd’s is turned on, similar to folders we just use a global wrapping counter so that way every file descriptor is guaranteed to be unique.

Errors

This will error if any file has ever been opened. This is because once a client has already connected, and done some stuff with file stuff it expects one set of behaviors, we cannot change another one.

pub async fn open_file( &self, open_options: OpenOptions, path: &PathBuf, stream_owner: Option<u64>, ) -> Result<i32, FSError>

Open a file, and return it’s file descriptor number.

Errors

If we cannot open our file with the open options provided.

pub async fn get_file( &self, fd: i32, for_stream: Option<u64>, ) -> Option<CMOccupiedEntry<'_, i32, (File, u64, PathBuf, Option<u64>), RandomState>>

Get a file from a file descriptor number.

This file must already be opened (in order to get the file descriptor).

pub async fn file_length(&self, fd: i32, for_stream: Option<u64>) -> Option<u64>

Get the file length from a file descriptor number.

This file must already be opened (in order to get the file descriptor).

pub async fn read_file( &self, fd: i32, total_data_to_read: usize, for_stream: Option<u64>, ) -> Result<Option<Bytes>, FSError>

Read from a file descriptor that is actively open.

This will read from a currently open file descriptor, in it’s current location. You might want to set your file location for this FD before if you aren’t already in the same location.

Errors

If the file descriptor is open, but we could not read from the open file descriptor.

pub async fn write_file( &self, fd: i32, data_to_write: Bytes, for_stream: Option<u64>, ) -> Result<(), FSError>

Write to a file descriptor that is actively open.

This will write from a currently open file descriptor, in it’s current location. You might want to set your file location for this FD before if you aren’t already in the same location.

Errors

If the file descriptor is open, but we could not write to the open file descriptor.

pub async fn seek_file( &self, fd: i32, begin: bool, for_stream: Option<u64>, ) -> Result<(), FSError>

Seek to the beginning or end of a file.

If begin is true then we will seek to the beginning of the file otherwise we will sync to the end of the file. Precise seeking is not supported at this time.

Errors

If we cannot seek to the beginning or end of the file.

pub async fn close_file(&self, fd: i32, for_stream: Option<u64>)

Decrement the ref count of handles to a file.

If ref count reaches 0 close the underlying file handle.

Errors

If we cannot close our file handle when our ref count reaches 0, or if the file isn’t open at all.

pub fn open_folder( &self, path: &PathBuf, for_stream: Option<u64>, ) -> Result<i32, FSError>

“Open” a folder, or an iterator over a directory.

There’s no real “open file handle”, or reversible directory iterator, so we just create an id from scratch.

Errors

If the path doesn’t exist, then we can’t open the folder.

pub async fn mark_folder_read_only(&self, path: PathBuf)

Mark a folder as being ‘read-only’ for this session.

Errors

If we could not actually insert the folder into the read only map.

pub async fn ensure_folder_not_read_only(&self, path: &PathBuf)

Mark a folder as being ‘read-write’ for this session.

pub async fn folder_is_read_only(&self, path: &PathBuf) -> bool

Check if a folder is marked as being read only.

pub async fn next_in_folder( &self, fd: i32, for_stream: Option<u64>, ) -> Result<Option<(PathBuf, usize)>, FSError>

Get the next filename/foldername available in a particular folder, and how many pieces to remove to get just the filename.

This will always return none even if it’s already at the end, unlike a particular iterator.

Errors

If we get an IO error from the underlying filesystem.

pub async fn reverse_folder( &self, fd: i32, for_stream: Option<u64>, ) -> Result<(), FSError>

Reverse a particular iterator over a folder by one.

Note: This will recreate the directory iterator, and will temporarily hold two references to [ReadDir] at a time because the underlying iterator from read directory is not a reversible iterator.

Errors

If opening another read dir call does not work.

pub async fn close_folder(&self, fd: i32, for_stream: Option<u64>)

Decrement the ref count of handles to a folder.

If ref count reaches 0 close the underlying folder handle.

Errors

If we cannot close our folder handle when our ref count reaches 0, or if the folder isn’t open at all.

pub async fn boot1_sytstem_path(&self) -> Result<PathBuf, FSError>

Get the path to the current boot1 .bsf file.

This function will create the boot1 system file, if it does not yet exist. As a result it may error, if we can’t create, and place the boot system file.

Errors

• If the temp directory does not exist, and we can’t create it.
• If the boot system file does not exist, and we can’t write it to disk.

pub async fn disk_id_path(&self) -> Result<PathBuf, FSError>

Get the path to the current diskid.bin.

If the current Disk ID does not exist, we will write a blank diskid to this path.

Errors

• If the temporary directory does not exist, and we can’t create it.
• If the disk ID path does not exist, and we can’t write it to disk.

pub fn firmware_file_path(&self) -> PathBuf

Get the path to the current firmware file to boot on the MION.

This is guaranteed to always exist, as it’s part of our check for a corrupt SDK.

pub async fn ppc_boot_dlf_path(&self) -> Result<PathBuf, CatBridgeError>

Get the path to the disk layout file for the PPC booting process.

This function will create a disk layout file, as well as a Boot System File, and a disk id file if they do not yet exist.

Errors

• If the temp directory does not exist, and we can’t create it.
• If the boot system file does not exist, and we can’t write it to disk.
• If the diskid file does not exist, and we can’t write it to disk.
• If the firmware image file does not exist.
• If the dlf file does not exist, and we can’t create it.

pub fn path_allows_writes(&self, path: &Path) -> bool

Check if a path is allowed to be writable.

pub fn resolve_path( &self, potentially_prefixed_path: &str, ) -> Result<ResolvedLocation, CatBridgeError>

Given a UTF-8 string path, get a pathbuf reference.

This understands the current following implementations:

• /%MLC_EMU_DIR
• /%SLC_EMU_DIR
• /%DISC_EMU_DIR
• /%SAVE_EMU_DIR
• /%NETWORK

Most of these are just quick ways of referncing the current set of directories, within cafe sdk. %NETWORK is the special one which references a currently mounted network share.

Errors

If the path requested is not in a mounted path.

pub fn create_directory(&self, at: &Path) -> Result<(), FSError>

Create a directory within a particular path.

Errors

If we cannot end up creating this directory due to a filesystem error.

pub fn copy(&self, from: &Path, to: &Path) -> Result<(), FSError>

Copy a file, symlink, or directory.

Errors

If we run into any filesystem error renaming a source, or directory.

pub fn rename(&self, from: &Path, to: &Path) -> Result<(), FSError>

Rename a file, symlink, or directory.

This is implemented so we can rename directories, and files without having to worry about the logic. Especially given the fact the built in rename doesn’t support directories.

Errors

• If we run into any filesystem error renaming a source, or directory.

pub fn slc_path_for(&self, title_id: TitleID) -> PathBuf

Get a file from the SLC.

The SLC always serves “sys” files, and are relative to a title id, almost always a system title id such as (00050010).

note: the file is not guaranteed to exist! It’s just a path!

pub fn default_cafe_folder() -> Option<PathBuf>

Get the current OS’s default directory path.

For Windows this is: C:\cafe_sdk. For Unix/BSD likes this is: /opt/cafe_sdk

Trait Implementations

impl Clone for HostFilesystem

fn clone(&self) -> HostFilesystem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostFilesystem

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

Formats the value using the given formatter.

impl FromRef<PcfsServerState> for HostFilesystem

Available on crate feature servers only.

fn from_ref(input: &PcfsServerState) -> Self

Available on crate features clients or servers only.

Converts to this type from a reference to the input type.

impl FromRef<SdioStreamState> for HostFilesystem

Available on crate feature servers only.

fn from_ref(input: &SdioStreamState) -> Self

Available on crate features clients or servers only.

Converts to this type from a reference to the input type.

impl Structable for HostFilesystem

fn definition(&self) -> StructDef<'_>

Returns the struct’s definition.

impl Valuable for HostFilesystem

fn as_value(&self) -> Value<'_>

Converts self into a Value instance.

fn visit(&self, visitor: &mut dyn Visit)

Calls the relevant method on Visit to extract data from self.

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)

where Self: Sized,

Calls Visit::visit_primitive_slice() with self.