busylib 0.0.6

BUSY Bar Rust HTTP client
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Wi-Fi schemas

use serde::{Deserialize, Serialize};

/// Wi-Fi status. Only `state` is always present.
///
/// Fields `ssid`, `bssid`, `channel`, `rssi`, `security`, and `ip_config` are only included
/// when state is "connected".
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StatusResponse {
    pub state: WifiState,
    /// Only present when connected
    pub ssid: Option<String>,
    /// Only present when connected
    pub bssid: Option<String>,
    /// Only present when connected
    pub channel: Option<u16>,
    /// Only present when connected
    pub rssi: Option<i32>,
    /// Only present when connected
    pub security: Option<WifiSecurityMethod>,
    /// Only present when connected
    pub ip_config: Option<WifiIpConfig>,
}

impl StatusResponse {
    pub fn is_connected(&self) -> bool {
        matches!(self.state, WifiState::Connected)
    }
}

/// States the Wi-Fi connection can be in
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum WifiState {
    Unknown,
    Disconnected,
    Connected,
    Connecting,
    Disconnecting,
    Reconnecting,
    #[serde(untagged)]
    Unrecognized(String),
}

/// Security methods a network can use
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum WifiSecurityMethod {
    Open,
    #[serde(rename = "WPA")]
    Wpa,
    #[serde(rename = "WPA2")]
    Wpa2,
    #[serde(rename = "WEP")]
    Wep,
    #[serde(rename = "WPA/WPA2")]
    WpaWpa2,
    #[serde(rename = "WPA3")]
    Wpa3,
    #[serde(rename = "WPA2/WPA3")]
    Wpa2Wpa3,
    Unsupported,
    #[serde(untagged)]
    Unknown(String),
}

/// IP configuration of the connection
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct WifiIpConfig {
    pub ip_method: Option<WifiIpMethod>,
    pub ip_type: Option<WifiIpType>,
    pub address: Option<String>,
}

/// How an IP address is obtained
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum WifiIpMethod {
    Dhcp,
    Static,
}

/// IP address families
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum WifiIpType {
    Ipv4,
    Ipv6,
}