Struct MionIdentity

pub struct MionIdentity { /* private fields */ }

An identity for a CAT-DEV that we received from the network.

Implementations

impl MionIdentity

pub fn new( detailed_data: Option<Bytes>, firmware_version: [u8; 4], fpga_version: [u8; 4], ip_address: Ipv4Addr, mac: MacAddress, name: String, ) -> Result<Self, MIONAPIError>

Create a new MION Identity from scratch.

Errors

• If the name is not ASCII.
• If the name is longer than 255 bytes.
• If the name is empty.

pub fn firmware_version(&self) -> String

The firmware version of the current CAT-DEV, rendered as a string you’d see displayed.

pub const fn raw_firmware_version(&self) -> [u8; 4]

The firmware version of the current CAT-DEV.

Each part is split into it’s own byte. If you want a string representation call MionIdentity::firmware_version.

pub fn fpga_version(&self) -> String

The FPGA of the current CAT-DEV, rendered as a string you’d see displayed in a list view.

pub fn detailed_fpga_version(&self) -> String

The FPGA of the current CAT-DEV, rendered as a string you’d see displayed in a detail view.

pub const fn raw_fpga_version(&self) -> [u8; 4]

The version of the FPGA on the CAT-DEV.

Each part is split into it’s own byte. If you want a string representation call MionIdentity::fpga_version.

pub const fn ip_address(&self) -> Ipv4Addr

The IP Address this identity belongs to.

pub const fn mac_address(&self) -> MacAddress

The Mac Address of the identity belongs to.

pub fn name(&self) -> &str

The name of this machine.

pub const fn is_detailed(&self) -> bool

If the data the client sent back to us was detailed, and contains extra bits of information.

NOTE: for old enough firmwares, even if you ask for detailed data you may not get it.

pub fn detailed_sdk_version(&self) -> Option<String>

If you’ve asked for, and received detailed information this will be the SDK version that the current dev-kit is running.

pub fn detailed_raw_sdk_version(&self) -> Option<[u8; 4]>

If you’ve asked for, and received detailed information this will be the SDK version that the current dev-kit is running.

These are the 4 raw bytes returned from the response. If you want to display these as a string somewhere you should use the method: MionIdentity::detailed_sdk_version.

pub fn detailed_boot_type(&self) -> Option<MIONBootType>

If you’ve asked for, and received detailed information this will be the boot-type that the device is configured to use.

pub fn detailed_is_cafe_on(&self) -> Option<bool>

If you’ve asked for, and received detailed information this will be the status of cafe being on/off.

Trait Implementations

impl Clone for MionIdentity

fn clone(&self) -> MionIdentity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MionIdentity

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

Formats the value using the given formatter.

impl Display for MionIdentity

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

Formats the value using the given formatter.

impl From<&MionIdentity> for Bytes

fn from(value: &MionIdentity) -> Self

Converts to this type from the input type.

impl From<MionIdentity> for Bytes

fn from(value: MionIdentity) -> Self

Converts to this type from the input type.

impl Hash for MionIdentity

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 MionIdentity

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

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

Returns the struct’s definition.

impl TryFrom<(Ipv4Addr, Bytes)> for MionIdentity

type Error = NetworkParseError

The type returned in the event of a conversion error.

fn try_from( (from_address, packet): (Ipv4Addr, Bytes), ) -> Result<Self, Self::Error>

Performs the conversion.

impl Valuable for MionIdentity

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.

impl Eq for MionIdentity

impl StructuralPartialEq for MionIdentity