Struct FSEmulConfig

pub struct FSEmulConfig { /* private fields */ }

Active configuration for file-system emulation.

This is generally soter along with the host-bridge configuration in a simple ini file without much configuration. All official nintendo tools will read from this file as opposed to querying the actual device itself.

Implementations

impl FSEmulConfig

pub async fn load() -> Result<Self, FSError>

Attempt to load the fsemul configuration from the filesystem.

This is commonly referred to as fsemul.ini, stored normally in Windows under the C:\Program Files\Nintendo\HostBridge\fsemul.ini file. This is where tools like fsemul store which ports are being used, and where things like Session Manager ports happen.

Errors

• If we cannot get the default host path for your OS.
• Any error case from FSEmulConfig::load_explicit_path.

pub async fn load_explicit_path(path: PathBuf) -> Result<Self, FSError>

Attempt to load the fsemul configuration file from the filesystem.

This is commonly referred to as fsemul.ini, and is a small Windows (so UTF8) ini file, separated by newlines being \r\n.

Errors

• If we cannot read from the file on the file system.
• If we cannot parse the data in the file as UTF8.
• If we cannot parse the data as an INI file.

pub fn get_atapi_emulation_port(&self) -> Option<u16>

Get the configured ATAPI Emulation port if one has been configured.

pub fn set_atapi_emulation_port(&mut self, port: u16)

Set the current ATAPI Emulation port.

pub fn get_debug_out_port(&self) -> Option<u16>

Get the configured debug out port if one has been configured.

pub fn set_debug_out_port(&mut self, port: u16)

Set the current Debug Out port.

pub fn get_debug_control_port(&self) -> Option<u16>

Get the configured debug control port if one has been configured.

pub fn set_debug_ctrl_port(&mut self, port: u16)

Set the current Debug Control port.

pub fn get_hio_out_port(&self) -> Option<u16>

Get the configured HIO out port if one has been configured.

pub fn set_hio_out_port(&mut self, port: u16)

Set the current HIO OUT port.

pub fn get_pcfs_character_port(&self) -> Option<u16>

Get the configured PCFS Character port if one has been configured.

pub fn set_pcfs_character_port(&mut self, port: u16)

Set the current PCFS Character port.

pub fn get_pcfs_block_port(&self) -> Option<u16>

Get the configured PCFS Block port if one has been configured.

pub fn set_pcfs_block_port(&mut self, port: u16)

Set the current PCFS Block port.

pub fn get_launch_control_port(&self) -> Option<u16>

Get the configured Launch Control port if one has been configured.

pub fn set_launch_control_port(&mut self, port: u16)

Set the current Launch Control port.

pub fn get_net_manage_port(&self) -> Option<u16>

Get the configured Net Manage port if one has been configured.

pub fn set_net_manage_port(&mut self, port: u16)

Set the current Net Manage port.

pub fn get_pcfs_sata_port(&self) -> Option<u16>

Get the configured PCFS Sata port if one has been configured.

pub fn set_pcfs_sata_port(&mut self, port: u16)

Set the current PCFS Sata port.

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

Write the current configuration to disk as a Windows INI file.

We always write the file with carriage returns \r\n (windows line endings), and in UTF-8. So we can always copy-paste the file onto a windows host and have it be read by the official tools without issue.

Errors

If we run into a system error when writing the file to the disk.

pub fn get_default_host_path() -> Option<PathBuf>

Get the default path that the bridge host state is supposed to be stored in.

NOTE: this directory is not necissarily guaranteed to exist.

Returns none when we can’t find an appropriate path to store bridge host state in.

Trait Implementations

impl Clone for FSEmulConfig

fn clone(&self) -> FSEmulConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FSEmulConfig

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

Formats the value using the given formatter.

impl PartialEq for FSEmulConfig

fn eq(&self, other: &FSEmulConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FSEmulConfig

impl StructuralPartialEq for FSEmulConfig