Enum BridgeType

pub enum BridgeType {
    Mion,
    Toucan,
}

As far as I can derive from the sources available that we can cleanly read (e.g. shell scripts) there are two types of CAT-DEV units. This enum describes those.

Variants

Mion

“MION” is the ‘standard’ cat-dev unit that most people probably have (and is in fact the only one the developers have).

MIONs are also refered to as “v3”, and “v4”. If you have a tan colored box you almost assuredly have a MION.

Toucan

A toucan is the other type of cat-dev unit referenced in some of the shell scripts.

We don’t have a ton of documentation on this particular bridge type mainly because we don’t actually own any of these bridge types. They generally be refered to as “v2” bridges.

Implementations

impl BridgeType

pub fn fetch_bridge_type() -> Option<Self>

Attempt to get the bridge type from the environment.

This will only return Some() when the environment variable CAFE_HARDWARE is set to a proper value. If it’s not set to a value then we will always return None.

A proper way to always get a bridge type would be doing something similar to what the scripts do which is fallback to a default:

let ty = cat_dev::mion::BridgeType::fetch_bridge_type().unwrap_or_default();

Trait Implementations

impl Clone for BridgeType

fn clone(&self) -> BridgeType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BridgeType

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

Formats the value using the given formatter.

impl Default for BridgeType

fn default() -> Self

Shell scripts default to using MION if all things are the same.

In general you probably want to use BridgeType::fetch_bridge_type, and should only use this default when using something like unwrap_or_default in case the bridge type isn’t in the environment.

impl Display for BridgeType

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

Formats the value using the given formatter.

impl Hash for BridgeType

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 BridgeType

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

impl Eq for BridgeType

impl StructuralPartialEq for BridgeType