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

/*
* 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
*/

mod v4;
mod v6;

#[allow(unreachable_pub)] // https://github.com/rust-lang/rust/issues/57411
pub use self::v4::Ipv4Cidr;
#[allow(unreachable_pub)]
pub use self::v6::Ipv6Cidr;

use thiserror::Error;

/// Error indicating that a CIDR range cannot be parsed or is handled with an invalid prefix length.
#[derive(Debug, Error)]
pub enum CidrError {
    /// Error returned when parsing a malformed CIDR range.
    #[error("Failed to parse CIDR: {0}")]
    Malformed(String),

    /// Error returned when converting from v4/v6 address mask to a prefix length.
    #[error("Invalid prefix length")]
    InvalidPrefixLength,
}

/// Common behaviors for interacting with CIDR ranges.
pub trait Cidr: Sized {
    /// Type of address, i.e. IPv4 or IPv6, associated with the CIDR.
    type Addr;

    /// Returns the IP address prefix.
    fn address(&self) -> Self::Addr;

    /// Returns the broadcast address in a CIDR range.
    fn broadcast(&self) -> Self::Addr;

    /// Checks whether an address is contained within the CIDR range.
    fn contains(&self, address: Self::Addr) -> bool;

    /// Returns the CIDR hostmask address.
    fn hostmask(&self) -> Self::Addr;

    /// Returns the CIDR prefix length.
    fn length(&self) -> usize;

    /// Returns the CIDR netmask.
    fn netmask(&self) -> Self::Addr;

    /// Returns the network address in a CIDR range.
    fn network(&self) -> Self::Addr;

    /// Returns a new CIDR range from a prefix length.
    fn new(address: Self::Addr, length: usize) -> Result<Self, CidrError>;

    /// Returns the number of possible addresses within the CIDR range.
    fn size(&self) -> usize;

    /// Returns a new CIDR range from a netmask.
    fn with_netmask(address: Self::Addr, netmask: Self::Addr) -> Result<Self, CidrError>;
}