pub struct Ipv4Net { /* private fields */ }
Expand description
An IPv4 network address.
See IpNet
for a type encompassing both IPv4 and IPv6 network
addresses.
Textual representation
Ipv4Net
provides a FromStr
implementation for parsing network
addresses represented in CIDR notation. See IETF RFC 4632 for the
CIDR notation.
Examples
use std::net::Ipv4Addr;
use ipnet::Ipv4Net;
let net: Ipv4Net = "10.1.1.0/24".parse().unwrap();
assert_eq!(Ok(net.network()), "10.1.1.0".parse());
Implementations
sourceimpl Ipv4Net
impl Ipv4Net
sourcepub fn new(ip: Ipv4Addr, prefix_len: u8) -> Result<Ipv4Net, PrefixLenError>
pub fn new(ip: Ipv4Addr, prefix_len: u8) -> Result<Ipv4Net, PrefixLenError>
Creates a new IPv4 network address from an Ipv4Addr
and prefix
length.
Examples
use std::net::Ipv4Addr;
use ipnet::{Ipv4Net, PrefixLenError};
let net = Ipv4Net::new(Ipv4Addr::new(10, 1, 1, 0), 24);
assert!(net.is_ok());
let bad_prefix_len = Ipv4Net::new(Ipv4Addr::new(10, 1, 1, 0), 33);
assert_eq!(bad_prefix_len, Err(PrefixLenError));
sourcepub fn trunc(&self) -> Ipv4Net
pub fn trunc(&self) -> Ipv4Net
Returns a copy of the network with the address truncated to the prefix length.
Examples
assert_eq!(
"192.168.12.34/16".parse::<Ipv4Net>().unwrap().trunc(),
"192.168.0.0/16".parse().unwrap()
);
sourcepub fn prefix_len(&self) -> u8
pub fn prefix_len(&self) -> u8
Returns the prefix length.
sourcepub fn max_prefix_len(&self) -> u8
pub fn max_prefix_len(&self) -> u8
Returns the maximum valid prefix length.
sourcepub fn netmask(&self) -> Ipv4Addr
pub fn netmask(&self) -> Ipv4Addr
Returns the network mask.
Examples
let net: Ipv4Net = "10.1.0.0/20".parse().unwrap();
assert_eq!(Ok(net.netmask()), "255.255.240.0".parse());
sourcepub fn hostmask(&self) -> Ipv4Addr
pub fn hostmask(&self) -> Ipv4Addr
Returns the host mask.
Examples
let net: Ipv4Net = "10.1.0.0/20".parse().unwrap();
assert_eq!(Ok(net.hostmask()), "0.0.15.255".parse());
sourcepub fn network(&self) -> Ipv4Addr
pub fn network(&self) -> Ipv4Addr
Returns the network address.
Examples
let net: Ipv4Net = "172.16.123.123/16".parse().unwrap();
assert_eq!(Ok(net.network()), "172.16.0.0".parse());
sourcepub fn broadcast(&self) -> Ipv4Addr
pub fn broadcast(&self) -> Ipv4Addr
Returns the broadcast address.
Examples
let net: Ipv4Net = "172.16.0.0/22".parse().unwrap();
assert_eq!(Ok(net.broadcast()), "172.16.3.255".parse());
sourcepub fn supernet(&self) -> Option<Ipv4Net>
pub fn supernet(&self) -> Option<Ipv4Net>
Returns the Ipv4Net
that contains this one.
Examples
let n1: Ipv4Net = "172.16.1.0/24".parse().unwrap();
let n2: Ipv4Net = "172.16.0.0/23".parse().unwrap();
let n3: Ipv4Net = "172.16.0.0/0".parse().unwrap();
assert_eq!(n1.supernet().unwrap(), n2);
assert_eq!(n3.supernet(), None);
sourcepub fn is_sibling(&self, other: &Ipv4Net) -> bool
pub fn is_sibling(&self, other: &Ipv4Net) -> bool
Returns true
if this network and the given network are
children of the same supernet.
Examples
let n1: Ipv4Net = "10.1.0.0/24".parse().unwrap();
let n2: Ipv4Net = "10.1.1.0/24".parse().unwrap();
let n3: Ipv4Net = "10.1.2.0/24".parse().unwrap();
assert!(n1.is_sibling(&n2));
assert!(!n2.is_sibling(&n3));
sourcepub fn hosts(&self) -> Ipv4AddrRangeⓘNotable traits for Ipv4AddrRangeimpl Iterator for Ipv4AddrRange type Item = Ipv4Addr;
pub fn hosts(&self) -> Ipv4AddrRangeⓘNotable traits for Ipv4AddrRangeimpl Iterator for Ipv4AddrRange type Item = Ipv4Addr;
Return an Iterator
over the host addresses in this network.
If the prefix length is less than 31 both the network address and broadcast address are excluded. These are only valid host addresses when the prefix length is 31.
Examples
let net: Ipv4Net = "10.0.0.0/30".parse().unwrap();
assert_eq!(net.hosts().collect::<Vec<Ipv4Addr>>(), vec![
"10.0.0.1".parse::<Ipv4Addr>().unwrap(),
"10.0.0.2".parse().unwrap(),
]);
let net: Ipv4Net = "10.0.0.0/31".parse().unwrap();
assert_eq!(net.hosts().collect::<Vec<Ipv4Addr>>(), vec![
"10.0.0.0".parse::<Ipv4Addr>().unwrap(),
"10.0.0.1".parse().unwrap(),
]);
sourcepub fn subnets(&self, new_prefix_len: u8) -> Result<Ipv4Subnets, PrefixLenError>
pub fn subnets(&self, new_prefix_len: u8) -> Result<Ipv4Subnets, PrefixLenError>
Returns an Iterator
over the subnets of this network with the
given prefix length.
Examples
let net: Ipv4Net = "10.0.0.0/24".parse().unwrap();
assert_eq!(net.subnets(26).unwrap().collect::<Vec<Ipv4Net>>(), vec![
"10.0.0.0/26".parse::<Ipv4Net>().unwrap(),
"10.0.0.64/26".parse().unwrap(),
"10.0.0.128/26".parse().unwrap(),
"10.0.0.192/26".parse().unwrap(),
]);
let net: Ipv4Net = "10.0.0.0/30".parse().unwrap();
assert_eq!(net.subnets(32).unwrap().collect::<Vec<Ipv4Net>>(), vec![
"10.0.0.0/32".parse::<Ipv4Net>().unwrap(),
"10.0.0.1/32".parse().unwrap(),
"10.0.0.2/32".parse().unwrap(),
"10.0.0.3/32".parse().unwrap(),
]);
let net: Ipv4Net = "10.0.0.0/24".parse().unwrap();
assert_eq!(net.subnets(23), Err(PrefixLenError));
let net: Ipv4Net = "10.0.0.0/24".parse().unwrap();
assert_eq!(net.subnets(33), Err(PrefixLenError));
sourcepub fn contains<T>(&self, other: T) -> bool where
Self: Contains<T>,
pub fn contains<T>(&self, other: T) -> bool where
Self: Contains<T>,
Test if a network address contains either another network address or an IP address.
Examples
let net: Ipv4Net = "192.168.0.0/24".parse().unwrap();
let net_yes: Ipv4Net = "192.168.0.0/25".parse().unwrap();
let net_no: Ipv4Net = "192.168.0.0/23".parse().unwrap();
let ip_yes: Ipv4Addr = "192.168.0.1".parse().unwrap();
let ip_no: Ipv4Addr = "192.168.1.0".parse().unwrap();
assert!(net.contains(&net));
assert!(net.contains(&net_yes));
assert!(!net.contains(&net_no));
assert!(net.contains(&ip_yes));
assert!(!net.contains(&ip_no));
sourcepub fn aggregate(networks: &Vec<Ipv4Net>) -> Vec<Ipv4Net>
pub fn aggregate(networks: &Vec<Ipv4Net>) -> Vec<Ipv4Net>
Aggregate a Vec
of Ipv4Net
s and return the result as a new
Vec
.
Examples
let nets = vec![
"10.0.0.0/24".parse::<Ipv4Net>().unwrap(),
"10.0.1.0/24".parse().unwrap(),
"10.0.2.0/24".parse().unwrap(),
];
assert_eq!(Ipv4Net::aggregate(&nets), vec![
"10.0.0.0/23".parse::<Ipv4Net>().unwrap(),
"10.0.2.0/24".parse().unwrap(),
]);
Trait Implementations
sourceimpl FromStr for Ipv4Net
impl FromStr for Ipv4Net
type Err = AddrParseError
type Err = AddrParseError
The associated error which can be returned from parsing.
sourceimpl Ord for Ipv4Net
impl Ord for Ipv4Net
sourceimpl PartialOrd<Ipv4Net> for Ipv4Net
impl PartialOrd<Ipv4Net> for Ipv4Net
sourcefn partial_cmp(&self, other: &Ipv4Net) -> Option<Ordering>
fn partial_cmp(&self, other: &Ipv4Net) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Copy for Ipv4Net
impl Eq for Ipv4Net
impl StructuralEq for Ipv4Net
impl StructuralPartialEq for Ipv4Net
Auto Trait Implementations
impl RefUnwindSafe for Ipv4Net
impl Send for Ipv4Net
impl Sync for Ipv4Net
impl Unpin for Ipv4Net
impl UnwindSafe for Ipv4Net
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more