bee-network 0.2.2

Networking functionality and types for nodes and clients participating in the IOTA protocol built on top of `libp2p`.
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

// Copyright 2020-2021 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use std::fmt;

/// Meta information about an established connection.
#[derive(Clone, Debug)]
pub struct ConnectionInfo {
    /// Whether the connection is inbound or outbound.
    pub origin: Origin,
}

/// Describes direction of an established connection.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Origin {
    /// The connection is inbound (local=server).
    Inbound,
    /// The connection is outbound (local=client).
    Outbound,
}

impl Origin {
    /// Returns whether the connection is inbound.
    pub fn is_inbound(&self) -> bool {
        matches!(self, Self::Inbound)
    }

    /// Returns whether the connection is outbound.
    pub fn is_outbound(&self) -> bool {
        matches!(self, Self::Outbound)
    }
}

impl fmt::Display for Origin {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match *self {
            Origin::Inbound => f.write_str("inbound"),
            Origin::Outbound => f.write_str("outbound"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn is_api() {
        let mut origin = Origin::Inbound;
        assert!(origin.is_inbound());

        origin = Origin::Outbound;
        assert!(origin.is_outbound());
    }

    #[test]
    fn display() {
        assert_eq!(&Origin::Inbound.to_string(), "inbound");
        assert_eq!(&Origin::Outbound.to_string(), "outbound");
    }
}