capsule 0.1.5

A framework for network function development. Written in Rust, inspired by NetBricks and built on Intel's Data Plane Development Kit.
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

/*
* Copyright 2019 Comcast Cable Communications Management, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
*/

use crate::packets::ip::v4::Ipv4;
use crate::packets::ip::v6::{Ipv6, SegmentRouting};
use crate::packets::{Ethernet, Packet, Tcp, Tcp4, Tcp6, Udp4, Udp6};

/// [`Packet`] extension trait.
///
/// Helper methods for packet conversion that make testing less verbose. Does
/// not guarantee that the result of the conversion will be a valid packet,
/// and will panic if the conversion fails.
///
/// [`Packet`]: crate::packets::Packet
pub trait PacketExt: Packet + Sized {
    /// Converts the packet into an Ethernet packet.
    fn into_eth(self) -> Ethernet {
        self.reset().parse::<Ethernet>().unwrap()
    }

    /// Converts the packet into an IPv4 packet.
    fn into_v4(self) -> Ipv4 {
        self.into_eth().parse::<Ipv4>().unwrap()
    }

    /// Converts the packet into a TCP packet inside IPv4.
    fn into_v4_tcp(self) -> Tcp4 {
        self.into_v4().parse::<Tcp4>().unwrap()
    }

    /// Converts the packet into a UDP packet inside IPv4.
    fn into_v4_udp(self) -> Udp4 {
        self.into_v4().parse::<Udp4>().unwrap()
    }

    /// Converts the packet into an IPv6 packet.
    fn into_v6(self) -> Ipv6 {
        self.into_eth().parse::<Ipv6>().unwrap()
    }

    /// Converts the packet into a TCP packet inside IPv6.
    fn into_v6_tcp(self) -> Tcp6 {
        self.into_v6().parse::<Tcp6>().unwrap()
    }

    /// Converts the packet into a UDP packet inside IPv6.
    fn into_v6_udp(self) -> Udp6 {
        self.into_v6().parse::<Udp6>().unwrap()
    }

    /// Converts the packet into an IPv6 packet with a SRH extension.
    fn into_sr(self) -> SegmentRouting<Ipv6> {
        self.into_v6().parse::<SegmentRouting<Ipv6>>().unwrap()
    }

    /// Converts the packet into a TCP packet inside IPv6 with a SRH extension.
    fn into_sr_tcp(self) -> Tcp<SegmentRouting<Ipv6>> {
        self.into_sr().parse::<Tcp<SegmentRouting<Ipv6>>>().unwrap()
    }
}

impl<T> PacketExt for T where T: Packet + Sized {}