SetupParameters

cat_dev::mion::proto::cgis

Struct SetupParameters 

Source 
pub struct SetupParameters { /* private fields */ }
Available on crate feature clients only.
Expand description

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§

Source§

impl SetupParameters

Source

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

Available on crate features clients or servers only.

Create a new setup set of parameters.

Source

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

Available on crate features clients or servers only.

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

Source

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

Available on crate features clients or servers only.

Get the static ip address being used.

This will return None if the console is using DHCP.

Source

pub const fn raw_static_ip_address(&self) -> Ipv4Addr

Available on crate features clients or servers only.

Get the value for the static ip address.

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

Source

pub const fn subnet_mask(&self) -> Ipv4Addr

Available on crate features clients or servers only.

Get the subnet mask for the CAT-DEV device.

Source

pub const fn default_gateway(&self) -> Ipv4Addr

Available on crate features clients or servers only.

Get the gateway to use for the CAT-DEV.

Source

pub const fn using_dhcp(&self) -> bool

Available on crate features clients or servers only.

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

Source

pub const fn using_self_managed_dns(&self) -> bool

Available on crate features clients or servers only.

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

Source

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

Available on crate features clients or servers only.

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.

Source

pub const fn raw_primary_dns(&self) -> Ipv4Addr

Available on crate features clients or servers only.

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.

Source

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

Available on crate features clients or servers only.

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.

Source

pub const fn raw_secondary_dns(&self) -> Ipv4Addr

Available on crate features clients or servers only.

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.

Source

pub const fn jumbo_frame(&self) -> bool

Available on crate features clients or servers only.

If we’re using jumbo frames.

Source

pub const fn host_pc_ip_address(&self) -> Ipv4Addr

Available on crate features clients or servers only.

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

Source

pub const fn hdd_bank_size(&self) -> CatDevBankSize

Available on crate features clients or servers only.

Get the hard disk size of the cat-dev.

Source

pub const fn hdd_bank_no(&self) -> u8

Available on crate features clients or servers only.

Get the bank number being used for the HDD.

Source

pub const fn atapi_emulator_port(&self) -> u16

Available on crate features clients or servers only.

The port for the ATAPI emulator.

Source

pub const fn sdio_printf_port(&self) -> u16

Available on crate features clients or servers only.

The port for SDIO Printf/Control.

Source

pub const fn sdio_block_port(&self) -> u16

Available on crate features clients or servers only.

The port for SDIO Block Data.

Source

pub const fn exi_port(&self) -> u16

Available on crate features clients or servers only.

Get the port for EXI traffic.

Source

pub const fn parameter_space_port(&self) -> u16

Available on crate features clients or servers only.

Get the port to use for parameter-space queries.

Source

pub const fn drive_timing_emulation_enabled(&self) -> bool

Available on crate features clients or servers only.

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

Source

pub const fn is_cat_dev_mode(&self) -> bool

Available on crate features clients or servers only.

Check if our operational mode is CAT-DEV mode.

Source

pub const fn is_h_reader_mode(&self) -> bool

Available on crate features clients or servers only.

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

Source

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

Available on crate features clients or servers only.

Get the hard-drive product revision.

Source

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

Available on crate features clients or servers only.

Get the hard-drive vendor code.

Source

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

Available on crate features clients or servers only.

Get the hard-drive device code.

Source

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

Available on crate features clients or servers only.

Get the release date of the internal hard-drive.

Source

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

Available on crate features clients or servers only.

Get the name of the cat-dev.

Source

pub const fn mac_address(&self) -> MacAddress

Available on crate features clients or servers only.

Trait Implementations§

Source§

impl Clone for SetupParameters

Available on crate features clients or servers only.
Source§

fn clone(&self) -> SetupParameters

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SetupParameters

Available on crate features clients or servers only.
Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for SetupParameters

Available on crate features clients or servers only.
Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SetupParameters

Available on crate features clients or servers only.
Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for SetupParameters

Available on crate features clients or servers only.
Source§

impl StructuralPartialEq for SetupParameters

Available on crate features clients or servers only.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compares self with key and returns true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<InnerTy> FromRef<InnerTy> for InnerTy
where InnerTy: Clone,

Source§

fn from_ref(input: &InnerTy) -> InnerTy

Available on crate features clients or servers only.
Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,