pignet 0.7.1

Netwok crate for use by other crates in the pigg project
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

#[cfg(feature = "iroh")]
use iroh::{NodeId, RelayUrl};
#[cfg(feature = "usb")]
use pigdef::description::SerialNumber;
use std::fmt::{Display, Formatter};
#[cfg(feature = "tcp")]
use std::net::IpAddr;

#[cfg(feature = "discovery")]
pub mod discovery;
#[cfg(feature = "iroh")]
pub mod iroh_host;
#[cfg(feature = "tcp")]
pub mod tcp_host;
#[cfg(feature = "usb")]
pub mod usb_host;

/// A type of connection to a piece of hardware
#[derive(Debug, Clone, Default, PartialEq, Eq, Hash)]
pub enum HardwareConnection {
    #[default]
    NoConnection,
    #[cfg(not(target_arch = "wasm32"))]
    Local,
    #[cfg(feature = "usb")]
    Usb(SerialNumber),
    #[cfg(feature = "iroh")]
    Iroh(NodeId, Option<RelayUrl>),
    #[cfg(feature = "tcp")]
    Tcp(IpAddr, u16),
}

impl HardwareConnection {
    /// Return a short name describing the connection type
    pub const fn name(&self) -> &'static str {
        match self {
            Self::NoConnection => "disconnected",
            #[cfg(not(target_arch = "wasm32"))]
            Self::Local => "Local",
            #[cfg(feature = "usb")]
            Self::Usb(_) => "USB",
            #[cfg(feature = "iroh")]
            Self::Iroh(_, _) => "Iroh",
            #[cfg(feature = "tcp")]
            Self::Tcp(_, _) => "TCP",
        }
    }
}

impl Display for HardwareConnection {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::NoConnection => write!(f, "No Connection"),
            #[cfg(not(target_arch = "wasm32"))]
            Self::Local => write!(f, "Local Hardware"),
            #[cfg(feature = "usb")]
            Self::Usb(serial) => write!(f, "USB: {serial}"),
            #[cfg(feature = "iroh")]
            Self::Iroh(nodeid, _relay_url) => write!(f, "Iroh: {nodeid}"),
            #[cfg(feature = "tcp")]
            Self::Tcp(ip, port) => write!(f, "TCP: {ip}:{port}"),
        }
    }
}