async_flow/io/
port_state.rs

1// This is free and unencumbered software released into the public domain.
2
3/// The current state of a port.
4#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
5#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
6#[cfg_attr(feature = "serde", serde(rename_all = "lowercase"))]
7pub enum PortState {
8    #[default]
9    Closed,
10    Open,
11    Connected,
12}
13
14impl PortState {
15    /// Checks whether the port state is currently closed.
16    pub fn is_closed(&self) -> bool {
17        *self == PortState::Closed
18    }
19
20    /// Checks whether the port state is currently open.
21    pub fn is_open(&self) -> bool {
22        *self == PortState::Open
23    }
24
25    /// Checks whether the port state is currently connected.
26    pub fn is_connected(&self) -> bool {
27        *self == PortState::Connected
28    }
29
30    pub fn as_str(&self) -> &str {
31        use PortState::*;
32        match self {
33            Closed => "closed",
34            Open => "open",
35            Connected => "connected",
36        }
37    }
38}
39
40impl AsRef<str> for PortState {
41    fn as_ref(&self) -> &str {
42        self.as_str()
43    }
44}