binator_network 0.0.1

binator network
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

//! Handles parsing of Ethernet headers

use binator::{
  base::octet,
  utils::{
    Utils,
    UtilsAtom,
  },
  Contexting,
  CoreAtom,
  Parse,
  Parsed,
  Streaming,
  Success,
};

use crate::ether_type::{
  ether_type,
  EtherType,
};

/// EthernetFrame
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct EthernetFrame {
  /// MAC destination
  pub destination: [u8; 6],
  /// MAC source
  pub source: [u8; 6],
  /// EtherType used
  pub ether_type: EtherType,
  /// TCI
  pub tci: Option<u16>,
}

/// Parser that return a ethernet frame on success
/// <https://en.wikipedia.org/wiki/Ethernet_frame>
pub fn ethernet_frame<Stream, Context>(stream: Stream) -> Parsed<EthernetFrame, Stream, Context>
where
  Stream: Clone,
  Stream: Eq,
  Stream: Streaming,
  Stream::Item: Into<u8>,
  Context: Contexting<CoreAtom<Stream>>,
  Context: Contexting<UtilsAtom<Stream>>,
  Context: Contexting<UtilsAtom<Stream>>,
{
  let Success {
    token: destination,
    stream,
  } = octet.fill().parse(stream)?;
  let Success {
    token: source,
    stream,
  } = octet.fill().parse(stream)?;
  let Success {
    token: (ether_type, tci),
    stream,
  } = ether_type
    .and_then(|tmp_ether_type| {
      move |stream: Stream| {
        if tmp_ether_type == EtherType::VLAN {
          let Success { token: tci, stream } =
            octet.fill().map(u16::from_be_bytes).parse(stream)?;
          let Success {
            token: ether_type,
            stream,
          } = ether_type.parse(stream)?;

          Parsed::Success {
            token: (ether_type, Some(tci)),
            stream,
          }
        } else {
          Parsed::Success {
            token: (tmp_ether_type, None),
            stream,
          }
        }
      }
    })
    .parse(stream)?;

  Parsed::Success {
    token: EthernetFrame {
      destination,
      source,
      ether_type,
      tci,
    },
    stream,
  }
}

#[cfg(test)]
mod tests {
  use binator::{
    context::Ignore,
    Parsed,
  };

  use super::{
    EtherType,
    EthernetFrame,
  };

  #[test]
  fn ethernet_frame() {
    let tests = [
      (
        &[
          0x00, 0x23, 0x54, 0x07, 0x93, 0x6C, 0x00, 0x1B, 0x21, 0x0F, 0x91, 0x9B, 0x08, 0x00,
        ][..],
        EthernetFrame {
          destination: [0x00, 0x23, 0x54, 0x07, 0x93, 0x6C],
          source: [0x00, 0x1B, 0x21, 0x0F, 0x91, 0x9B],
          ether_type: EtherType::IPV4,
          tci: None,
        },
      ),
      (
        &[
          0x00, 0x23, 0x54, 0x07, 0x93, 0x6C, 0x00, 0x1B, 0x21, 0x0F, 0x91, 0x9B, 0x81, 0x00, 0x04,
          0xD2, 0x08, 0x00,
        ][..],
        EthernetFrame {
          destination: [0x00, 0x23, 0x54, 0x07, 0x93, 0x6C],
          source: [0x00, 0x1B, 0x21, 0x0F, 0x91, 0x9B],
          ether_type: EtherType::IPV4,
          tci: Some(1234),
        },
      ),
    ];

    for (stream, expected) in tests {
      assert_eq!(
        super::ethernet_frame::<_, Ignore>(stream),
        Parsed::Success {
          token: expected,
          stream: b"".as_slice(),
        }
      );
    }
  }
}