generic-ip 0.1.1

IP address types for generic programming
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

use core::fmt;

use super::PrefixLength;
use crate::{
    concrete::{
        self,
        mask_types::{Bit, Host, Net, Type},
        Ipv4, Ipv6,
    },
    traits,
};

/// Either an IPv4 or IPv6 address mask.
///
/// # Memory Use
///
/// Rust enums are sized to accomodate their largest variant, with smaller
/// variants being padded to fill up any unused space.
///
/// As a result, users should avoid using this type in a context where only
/// [`Mask::Ipv4`] variants are expected.
#[allow(variant_size_differences)]
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
pub enum Mask<T: Type> {
    /// IPv4 address mask variant.
    Ipv4(concrete::Mask<T, Ipv4>),
    /// IPv6 address mask variant.
    Ipv6(concrete::Mask<T, Ipv6>),
}

/// Either an IPv4 or IPv6 netmask.
pub type Netmask = Mask<Net>;

/// Either an IPv4 or IPv6 netmask.
pub type Hostmask = Mask<Host>;

/// Either an IPv4 or IPv6 bitmask.
pub type Bitmask = Mask<Bit>;

impl<T: Type> traits::Mask for Mask<T> {}
impl traits::Netmask for Netmask {}
impl traits::Hostmask for Hostmask {}
impl traits::Bitmask for Bitmask {}

impl<T: Type> From<concrete::Mask<T, Ipv4>> for Mask<T> {
    fn from(mask: concrete::Mask<T, Ipv4>) -> Self {
        Self::Ipv4(mask)
    }
}

impl<T: Type> From<concrete::Mask<T, Ipv6>> for Mask<T> {
    fn from(mask: concrete::Mask<T, Ipv6>) -> Self {
        Self::Ipv6(mask)
    }
}

impl From<PrefixLength> for Netmask {
    fn from(len: PrefixLength) -> Self {
        match len {
            PrefixLength::Ipv4(len) => Self::Ipv4(len.into()),
            PrefixLength::Ipv6(len) => Self::Ipv6(len.into()),
        }
    }
}

impl From<PrefixLength> for Hostmask {
    fn from(len: PrefixLength) -> Self {
        match len {
            PrefixLength::Ipv4(len) => Self::Ipv4(len.into()),
            PrefixLength::Ipv6(len) => Self::Ipv6(len.into()),
        }
    }
}

impl<T: Type> fmt::Display for Mask<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Ipv4(mask) => mask.fmt(f),
            Self::Ipv6(mask) => mask.fmt(f),
        }
    }
}

// TODO: impl FromStr
// TODO: impl Arbitrary