Struct SetupParameters

pub struct SetupParameters { /* private fields */ }

The parameters you can fetch from the setup.cgi page.

While this page is normally really more intended for humans, rather than an automated parsers. HOWEVER, fsemul & several other useful functions are only available on this page.

Why they’re not available in the parameter space, or why there’s not a get_param action, but is a set_param action I’ll never know. It will make me sad though.

Implementations

impl SetupParameters

pub const fn new( static_ip_address: Ipv4Addr, subnet_mask: Ipv4Addr, default_gateway: Ipv4Addr, dhcp: bool, dns: bool, primary_dns_server: Ipv4Addr, secondary_dns_server: Ipv4Addr, jumbo_frame: bool, host_pc_ip: Ipv4Addr, bank_size: CatDevBankSize, hdd_bank_no: u8, atapi_emulator_port: u16, sdio_printf_port: u16, sdio_block_port: u16, exi_port: u16, parameter_space_port: u16, drive_timing_emulation: bool, operational_mode_is_reader: bool, drive_product_revision: String, drive_vendor_code: String, drive_device_code: String, drive_release_date: String, device_name: String, mac_address: MacAddress, ) -> Self

Create a new setup set of parameters.

pub fn default_settings(device_name: String, mac_address: MacAddress) -> Self

Create a new set of default settings based on the device name, and mac.

pub const fn static_ip_address(&self) -> Option<Ipv4Addr>

Get the static ip address being used.

This will return None if the console is using DHCP.

pub const fn raw_static_ip_address(&self) -> Ipv4Addr

Get the value for the static ip address.

note: may not be correct, and used if dhcp is on.

pub const fn subnet_mask(&self) -> Ipv4Addr

Get the subnet mask for the CAT-DEV device.

pub const fn default_gateway(&self) -> Ipv4Addr

Get the gateway to use for the CAT-DEV.

pub const fn using_dhcp(&self) -> bool

If we’re using DHCP to get an IP Address.

pub const fn using_self_managed_dns(&self) -> bool

If we’re using our own DNS ips set in our configuration.

pub const fn primary_dns(&self) -> Option<Ipv4Addr>

Get the primary dns server the cat-dev will be using.

note: this will return none if the cat-dev isn’t using self managed dns.

pub const fn raw_primary_dns(&self) -> Ipv4Addr

Get the raw value of the Primary DNS Server for the cat-dev.

*note: this value will not be used if self managed dns is off.

pub const fn secondary_dns(&self) -> Option<Ipv4Addr>

Get the secondary dns server the cat-dev will be using.

note: this will return none if the cat-dev isn’t using self managed dns.

pub const fn raw_secondary_dns(&self) -> Ipv4Addr

Get the raw value of the Secondary DNS Server for the cat-dev.

*note: this value will not be used if self managed dns is off.

pub const fn jumbo_frame(&self) -> bool

If we’re using jumbo frames.

pub const fn host_pc_ip_address(&self) -> Ipv4Addr

The potential IP Address of the host machine we’re using.

pub const fn hdd_bank_size(&self) -> CatDevBankSize

Get the hard disk size of the cat-dev.

pub const fn hdd_bank_no(&self) -> u8

Get the bank number being used for the HDD.

pub const fn atapi_emulator_port(&self) -> u16

The port for the ATAPI emulator.

pub const fn sdio_printf_port(&self) -> u16

The port for SDIO Printf/Control.

pub const fn sdio_block_port(&self) -> u16

The port for SDIO Block Data.

pub const fn exi_port(&self) -> u16

Get the port for EXI traffic.

pub const fn parameter_space_port(&self) -> u16

Get the port to use for parameter-space queries.

pub const fn drive_timing_emulation_enabled(&self) -> bool

If we’re using drive-timing emulation of a production console.

pub const fn is_cat_dev_mode(&self) -> bool

Check if our operational mode is CAT-DEV mode.

pub const fn is_h_reader_mode(&self) -> bool

Check if our operational mode is in H-Reader mode.

pub const fn drive_product_revision(&self) -> &String

Get the hard-drive product revision.

pub const fn drive_vendor_code(&self) -> &String

Get the hard-drive vendor code.

pub const fn drive_device_code(&self) -> &String

Get the hard-drive device code.

pub const fn drive_release_date(&self) -> &String

Get the release date of the internal hard-drive.

pub const fn device_name(&self) -> &String

Get the name of the cat-dev.

pub const fn mac_address(&self) -> MacAddress

Trait Implementations

impl Clone for SetupParameters

fn clone(&self) -> SetupParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetupParameters

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

Formats the value using the given formatter.

impl Hash for SetupParameters

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SetupParameters

fn eq(&self, other: &SetupParameters) -> 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 SetupParameters

impl StructuralPartialEq for SetupParameters