Enum ipnet::IpNet

pub enum IpNet {
    V4(Ipv4Net),
    V6(Ipv6Net),
}

An IP network address, either IPv4 or IPv6.

This enum can contain either an Ipv4Net or an Ipv6Net, see their respective documentation for more details.

Examples

use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use std::str::FromStr;
use ipnet::{IpNet, Ipv4Net, Ipv6Net};

let net_v4 = IpNet::from_str("10.1.1.0/24").unwrap();
let net_v6 = IpNet::from_str("fd00::/32").unwrap();
 
assert_eq!("10.1.1.0".parse(), Ok(net_v4.network()));
assert_eq!("fd00::".parse(), Ok(net_v6.network()));

Variants

V4(Ipv4Net)V6(Ipv6Net)

Methods

impl IpNet

fn addr(&self) -> IpAddr

Return the address.

fn prefix_len(&self) -> u8

Return the prefix length.

fn netmask(&self) -> IpAddr

Returns the network mask.

Examples

let net = IpNet::from_str("10.1.0.0/20").unwrap();
assert_eq!(net.netmask(), IpAddr::from_str("255.255.240.0").unwrap());

let net = IpNet::from_str("fd00::/24").unwrap();
assert_eq!(net.netmask(), IpAddr::from_str("ffff:ff00::").unwrap());

fn hostmask(&self) -> IpAddr

Returns the host mask.

Examples

let net = IpNet::from_str("10.1.0.0/20").unwrap();
assert_eq!(net.hostmask(), IpAddr::from_str("0.0.15.255").unwrap());

let net = IpNet::from_str("fd00::/24").unwrap();
assert_eq!(net.hostmask(), IpAddr::from_str("::ff:ffff:ffff:ffff:ffff:ffff:ffff").unwrap());

fn network(&self) -> IpAddr

Returns the network address.

Examples

let net = IpNet::from_str("172.16.123.123/16").unwrap();
assert_eq!(net.network(), IpAddr::from_str("172.16.0.0").unwrap());

let net = IpNet::from_str("fd00:1234:5678::/24").unwrap();
assert_eq!(net.network(), IpAddr::from_str("fd00:1200::").unwrap());

fn broadcast(&self) -> IpAddr

Returns the broadcast address.

Examples

let net = IpNet::from_str("172.16.0.0/22").unwrap();
assert_eq!(net.broadcast(), IpAddr::from_str("172.16.3.255").unwrap());

let net = IpNet::from_str("fd00:1234:5678::/24").unwrap();
assert_eq!(net.broadcast(), IpAddr::from_str("fd00:12ff:ffff:ffff:ffff:ffff:ffff:ffff").unwrap());

fn trunc(&self) -> IpNet

Return a copy of the network with the address truncated to the prefix length.

Examples

assert_eq!(
    IpNet::from_str("192.168.1.2/16").unwrap().trunc(),
    IpNet::from_str("192.168.0.0/16").unwrap()
);

fn supernet(&self) -> Option<IpNet>

Returns the IpNet that contains this one.

Examples

let n1 = IpNet::from_str("172.16.1.0/24").unwrap();
let n2 = IpNet::from_str("172.16.0.0/23").unwrap();
let n3 = IpNet::from_str("172.16.0.0/0").unwrap();

assert_eq!(n1.supernet().unwrap(), n2);
assert_eq!(n3.supernet(), None);

let n1 = IpNet::from_str("fd00:ff00::/24").unwrap();
let n2 = IpNet::from_str("fd00:fe00::/23").unwrap();
let n3 = IpNet::from_str("fd00:fe00::/0").unwrap();

assert_eq!(n1.supernet().unwrap(), n2);
assert_eq!(n3.supernet(), None);

fn is_sibling(&self, other: &IpNet) -> bool

Returns true if this network and the given network are children of the same supernet.

Examples

let net4_1 = IpNet::from_str("10.1.0.0/24").unwrap();
let net4_2 = IpNet::from_str("10.1.1.0/24").unwrap();
let net4_3 = IpNet::from_str("10.1.2.0/24").unwrap();
let net6_1 = IpNet::from_str("fd00::/18").unwrap();
let net6_2 = IpNet::from_str("fd00:4000::/18").unwrap();
let net6_3 = IpNet::from_str("fd00:8000::/18").unwrap();

assert!( net4_1.is_sibling(&net4_2));
assert!(!net4_2.is_sibling(&net4_3));
assert!( net6_1.is_sibling(&net6_2));
assert!(!net6_2.is_sibling(&net6_3));
assert!(!net4_1.is_sibling(&net6_2));

fn hosts(&self) -> IpAddrIter<IpAddr>

Return an Iterator over the host addresses in this network.

See the implementations on Ipv4Net and Ipv6Net for more information.

Examples

let net = IpNet::from_str("10.0.0.0/30").unwrap();
assert_eq!(net.hosts().collect::<Vec<IpAddr>>(), vec![
    IpAddr::from_str("10.0.0.1").unwrap(),
    IpAddr::from_str("10.0.0.2").unwrap(),
]);

let net = IpNet::from_str("10.0.0.0/31").unwrap();
assert_eq!(net.hosts().collect::<Vec<IpAddr>>(), vec![
    IpAddr::from_str("10.0.0.0").unwrap(),
    IpAddr::from_str("10.0.0.1").unwrap(),
]);

let net = IpNet::from_str("fd00::/126").unwrap();
assert_eq!(net.hosts().collect::<Vec<IpAddr>>(), vec![
    IpAddr::from_str("fd00::").unwrap(),
    IpAddr::from_str("fd00::1").unwrap(),
    IpAddr::from_str("fd00::2").unwrap(),
    IpAddr::from_str("fd00::3").unwrap(),
]);

fn subnets(&self, new_prefix_len: u8) -> Result<Subnets<IpAddr>, PrefixLenError>

Returns an Iterator over the subnets of this network with the given prefix length.

Examples

let net = IpNet::from_str("10.0.0.0/24").unwrap();
assert_eq!(net.subnets(26).unwrap().collect::<Vec<IpNet>>(), vec![
    IpNet::from_str("10.0.0.0/26").unwrap(),
    IpNet::from_str("10.0.0.64/26").unwrap(),
    IpNet::from_str("10.0.0.128/26").unwrap(),
    IpNet::from_str("10.0.0.192/26").unwrap(),
]);

let net = IpNet::from_str("fd00::/16").unwrap();
assert_eq!(net.subnets(18).unwrap().collect::<Vec<IpNet>>(), vec![
    IpNet::from_str("fd00::/18").unwrap(),
    IpNet::from_str("fd00:4000::/18").unwrap(),
    IpNet::from_str("fd00:8000::/18").unwrap(),
    IpNet::from_str("fd00:c000::/18").unwrap(),
]);

let net = IpNet::from_str("10.0.0.0/24").unwrap();
assert_eq!(net.subnets(23), Err(PrefixLenError));

let net = IpNet::from_str("10.0.0.0/24").unwrap();
assert_eq!(net.subnets(33), Err(PrefixLenError));

let net = IpNet::from_str("fd00::/16").unwrap();
assert_eq!(net.subnets(15), Err(PrefixLenError));

let net = IpNet::from_str("fd00::/16").unwrap();
assert_eq!(net.subnets(129), Err(PrefixLenError));

fn aggregate(networks: &Vec<IpNet>) -> Vec<IpNet>

Aggregate a Vec of IpNets and return the result as a new Vec.

Examples

let ipnets = vec![
    IpNet::from_str("10.0.0.0/24").unwrap(),
    IpNet::from_str("10.0.1.0/24").unwrap(),
    IpNet::from_str("10.0.2.0/24").unwrap(),
    IpNet::from_str("fd00::/18").unwrap(),
    IpNet::from_str("fd00:4000::/18").unwrap(),
    IpNet::from_str("fd00:8000::/18").unwrap(),
];
assert_eq!(IpNet::aggregate(&ipnets), vec![
    IpNet::from_str("10.0.0.0/23").unwrap(),
    IpNet::from_str("10.0.2.0/24").unwrap(),
    IpNet::from_str("fd00::/17").unwrap(),
    IpNet::from_str("fd00:8000::/18").unwrap(),
]);

Trait Implementations

impl Copy for IpNet

impl Clone for IpNet

fn clone(&self) -> IpNet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Eq for IpNet

impl PartialEq for IpNet

fn eq(&self, __arg_0: &IpNet) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &IpNet) -> bool

This method tests for !=.

impl Ord for IpNet

fn cmp(&self, __arg_0: &IpNet) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

🔬 This is a nightly-only experimental API. (ord_max_min)

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

🔬 This is a nightly-only experimental API. (ord_max_min)

Compares and returns the minimum of two values.

impl PartialOrd for IpNet

fn partial_cmp(&self, __arg_0: &IpNet) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &IpNet) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &IpNet) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &IpNet) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &IpNet) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Hash for IpNet

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for IpNet

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for IpNet

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl From<Ipv4Net> for IpNet

fn from(net: Ipv4Net) -> IpNet

Performs the conversion.

impl From<Ipv6Net> for IpNet

fn from(net: Ipv6Net) -> IpNet

Performs the conversion.

impl<'a> Contains<&'a IpNet> for IpNet

fn contains(&self, other: &IpNet) -> bool

Returns true if this network contains the given network or address.

impl<'a> Contains<&'a IpAddr> for IpNet

fn contains(&self, other: &IpAddr) -> bool

Returns true if this network contains the given network or address.

impl FromStr for IpNet

type Err = AddrParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<IpNet, AddrParseError>

Parses a string s to return a value of this type.