Enum MIONFindBy

pub enum MIONFindBy {
    Ip(Ipv4Addr),
    MacAddress(MacAddress),
    Name(String),
}

A way to search for a single MION board.

Some of these can end up causing a full discovery broadcast, some of them cause just a single packet to a single ip address. You can parse these from a string or from one of the associated types.

Variants

Ip(Ipv4Addr)

Search by a specific IP Address.

The IP Address has to be a V4 address, as the MIONs do not actually support being on an IPv6 address, and using DHCPv6.

This searching type will only send a specific request to the specific IPv4 address that you’ve specified here. IT WILL NOT cause a full broadcast to happen.

MacAddress(MacAddress)

Search by a mac address coming from a specific device.

This searching type will cause a FULL Broadcast to happen. Meaning we will receive potentially many mac addresses that we have to ignore. We could in theory avoid this by using RARP (aka reverse arp) requests. However, that requires running as an administrator on many OS’s to issue full RARP’s requests. In theory we could parse things like /proc/net/arp, but that requires doing things like sending pings/broadcasts first which isn’t always possible, especially because we don’t know the IP Address before hand.

Maybe one day it would be possible to use RARP requests.

Name(String)

Search by the name of a Cat-Dev Bridge.

This searching type will cause a FULL Broadcast to happen. Meaning we will receive potentially many broadcast responses that we might have to ignore. There isn’t really a way to avoid this without keeping a cache somewhere. In theory a user could still this, and just pass in find by ip with their own cache.

Implementations

impl MIONFindBy

pub fn from_name_or_ip(value: String) -> Self

Techincally the name can collide with a mac address, and even techincally an IP.

To help provide similar APIs to the CLIs we offer MIONFindBy::Name(value), and MIONFindBy::from_name_or_ip(value), and finally MIONFindBy::from(value) to let you choose which collisions if any you’re okay with.

pub const fn will_cause_full_scan(&self) -> bool

Determine if the scanning method you’re actively using will cause a full scan of the network.

Trait Implementations

impl Clone for MIONFindBy

fn clone(&self) -> MIONFindBy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MIONFindBy

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

Formats the value using the given formatter.

impl Display for MIONFindBy

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

Formats the value using the given formatter.

impl From<String> for MIONFindBy

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for MIONFindBy

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 MIONFindBy

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

impl StructuralPartialEq for MIONFindBy