Struct ipnet::Ipv4Net [−][src]
pub struct Ipv4Net { /* fields omitted */ }
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());
Methods
impl Ipv4Net
[src]
impl Ipv4Net
pub fn new(ip: Ipv4Addr, prefix_len: u8) -> Result<Ipv4Net, PrefixLenError>
[src]
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));
pub fn trunc(&self) -> Ipv4Net
[src]
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() );
pub fn addr(&self) -> Ipv4Addr
[src]
pub fn addr(&self) -> Ipv4Addr
Returns the address.
pub fn prefix_len(&self) -> u8
[src]
pub fn prefix_len(&self) -> u8
Returns the prefix length.
pub fn max_prefix_len(&self) -> u8
[src]
pub fn max_prefix_len(&self) -> u8
Returns the maximum valid prefix length.
pub fn netmask(&self) -> Ipv4Addr
[src]
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());
pub fn hostmask(&self) -> Ipv4Addr
[src]
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());
pub fn network(&self) -> Ipv4Addr
[src]
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());
pub fn broadcast(&self) -> Ipv4Addr
[src]
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());
pub fn supernet(&self) -> Option<Ipv4Net>
[src]
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);
pub fn is_sibling(&self, other: &Ipv4Net) -> bool
[src]
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));
ⓘImportant traits for Ipv4AddrRangepub fn hosts(&self) -> Ipv4AddrRange
[src]
pub fn hosts(&self) -> Ipv4AddrRange
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(), ]);
pub fn subnets(&self, new_prefix_len: u8) -> Result<Ipv4Subnets, PrefixLenError>
[src]
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));
pub fn aggregate(networks: &Vec<Ipv4Net>) -> Vec<Ipv4Net>
[src]
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(), ]);
Methods from Deref<Target = Ipv4Addr>
pub fn octets(&self) -> [u8; 4]
1.0.0[src]
pub fn octets(&self) -> [u8; 4]
Returns the four eight-bit integers that make up this address.
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::new(127, 0, 0, 1); assert_eq!(addr.octets(), [127, 0, 0, 1]);
pub fn is_unspecified(&self) -> bool
1.12.0[src]
pub fn is_unspecified(&self) -> bool
Returns true
for the special 'unspecified' address (0.0.0.0).
This property is defined in UNIX Network Programming, Second Edition, W. Richard Stevens, p. 891; see also ip7.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_unspecified(), true); assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_unspecified(), false);
pub fn is_loopback(&self) -> bool
1.7.0[src]
pub fn is_loopback(&self) -> bool
Returns true
if this is a loopback address (127.0.0.0/8).
This property is defined by IETF RFC 1122.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_loopback(), true); assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_loopback(), false);
pub fn is_private(&self) -> bool
1.7.0[src]
pub fn is_private(&self) -> bool
Returns true
if this is a private address.
The private address ranges are defined in IETF RFC 1918 and include:
- 10.0.0.0/8
- 172.16.0.0/12
- 192.168.0.0/16
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(10, 0, 0, 1).is_private(), true); assert_eq!(Ipv4Addr::new(10, 10, 10, 10).is_private(), true); assert_eq!(Ipv4Addr::new(172, 16, 10, 10).is_private(), true); assert_eq!(Ipv4Addr::new(172, 29, 45, 14).is_private(), true); assert_eq!(Ipv4Addr::new(172, 32, 0, 2).is_private(), false); assert_eq!(Ipv4Addr::new(192, 168, 0, 2).is_private(), true); assert_eq!(Ipv4Addr::new(192, 169, 0, 2).is_private(), false);
pub fn is_link_local(&self) -> bool
1.7.0[src]
pub fn is_link_local(&self) -> bool
Returns true
if the address is link-local (169.254.0.0/16).
This property is defined by IETF RFC 3927.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(169, 254, 0, 0).is_link_local(), true); assert_eq!(Ipv4Addr::new(169, 254, 10, 65).is_link_local(), true); assert_eq!(Ipv4Addr::new(16, 89, 10, 65).is_link_local(), false);
pub fn is_global(&self) -> bool
[src]
pub fn is_global(&self) -> bool
🔬 This is a nightly-only experimental API. (ip
)
extra functionality has not been scrutinized to the level that it should be to be stable
Returns true
if the address appears to be globally routable.
See iana-ipv4-special-registry.
The following return false:
- private address (10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16)
- the loopback address (127.0.0.0/8)
- the link-local address (169.254.0.0/16)
- the broadcast address (255.255.255.255/32)
- test addresses used for documentation (192.0.2.0/24, 198.51.100.0/24 and 203.0.113.0/24)
- the unspecified address (0.0.0.0)
Examples
#![feature(ip)] use std::net::Ipv4Addr; fn main() { assert_eq!(Ipv4Addr::new(10, 254, 0, 0).is_global(), false); assert_eq!(Ipv4Addr::new(192, 168, 10, 65).is_global(), false); assert_eq!(Ipv4Addr::new(172, 16, 10, 65).is_global(), false); assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_global(), false); assert_eq!(Ipv4Addr::new(80, 9, 12, 3).is_global(), true); }
pub fn is_multicast(&self) -> bool
1.7.0[src]
pub fn is_multicast(&self) -> bool
Returns true
if this is a multicast address (224.0.0.0/4).
Multicast addresses have a most significant octet between 224 and 239, and is defined by IETF RFC 5771.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(224, 254, 0, 0).is_multicast(), true); assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_multicast(), true); assert_eq!(Ipv4Addr::new(172, 16, 10, 65).is_multicast(), false);
pub fn is_broadcast(&self) -> bool
1.7.0[src]
pub fn is_broadcast(&self) -> bool
Returns true
if this is a broadcast address (255.255.255.255).
A broadcast address has all octets set to 255 as defined in IETF RFC 919.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_broadcast(), true); assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_broadcast(), false);
pub fn is_documentation(&self) -> bool
1.7.0[src]
pub fn is_documentation(&self) -> bool
Returns true
if this address is in a range designated for documentation.
This is defined in IETF RFC 5737:
- 192.0.2.0/24 (TEST-NET-1)
- 198.51.100.0/24 (TEST-NET-2)
- 203.0.113.0/24 (TEST-NET-3)
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(192, 0, 2, 255).is_documentation(), true); assert_eq!(Ipv4Addr::new(198, 51, 100, 65).is_documentation(), true); assert_eq!(Ipv4Addr::new(203, 0, 113, 6).is_documentation(), true); assert_eq!(Ipv4Addr::new(193, 34, 17, 19).is_documentation(), false);
pub fn to_ipv6_compatible(&self) -> Ipv6Addr
1.0.0[src]
pub fn to_ipv6_compatible(&self) -> Ipv6Addr
Converts this address to an IPv4-compatible IPv6 address.
a.b.c.d becomes ::a.b.c.d
Examples
use std::net::{Ipv4Addr, Ipv6Addr}; assert_eq!(Ipv4Addr::new(192, 0, 2, 255).to_ipv6_compatible(), Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 767));
pub fn to_ipv6_mapped(&self) -> Ipv6Addr
1.0.0[src]
pub fn to_ipv6_mapped(&self) -> Ipv6Addr
Converts this address to an IPv4-mapped IPv6 address.
a.b.c.d becomes ::ffff:a.b.c.d
Examples
use std::net::{Ipv4Addr, Ipv6Addr}; assert_eq!(Ipv4Addr::new(192, 0, 2, 255).to_ipv6_mapped(), Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 49152, 767));
Trait Implementations
impl Copy for Ipv4Net
[src]
impl Copy for Ipv4Net
impl Clone for Ipv4Net
[src]
impl Clone for Ipv4Net
fn clone(&self) -> Ipv4Net
[src]
fn clone(&self) -> Ipv4Net
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Eq for Ipv4Net
[src]
impl Eq for Ipv4Net
impl PartialEq for Ipv4Net
[src]
impl PartialEq for Ipv4Net
fn eq(&self, other: &Ipv4Net) -> bool
[src]
fn eq(&self, other: &Ipv4Net) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Ipv4Net) -> bool
[src]
fn ne(&self, other: &Ipv4Net) -> bool
This method tests for !=
.
impl Ord for Ipv4Net
[src]
impl Ord for Ipv4Net
fn cmp(&self, other: &Ipv4Net) -> Ordering
[src]
fn cmp(&self, other: &Ipv4Net) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl PartialOrd for Ipv4Net
[src]
impl PartialOrd for Ipv4Net
fn partial_cmp(&self, other: &Ipv4Net) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Ipv4Net) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Ipv4Net) -> bool
[src]
fn lt(&self, other: &Ipv4Net) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Ipv4Net) -> bool
[src]
fn le(&self, other: &Ipv4Net) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Ipv4Net) -> bool
[src]
fn gt(&self, other: &Ipv4Net) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Ipv4Net) -> bool
[src]
fn ge(&self, other: &Ipv4Net) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Hash for Ipv4Net
[src]
impl Hash for Ipv4Net
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Deref for Ipv4Net
[src]
impl Deref for Ipv4Net
type Target = Ipv4Addr
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
fn deref(&self) -> &Self::Target
Dereferences the value.
impl From<Ipv4Net> for IpNet
[src]
impl From<Ipv4Net> for IpNet
impl Debug for Ipv4Net
[src]
impl Debug for Ipv4Net
fn fmt(&self, fmt: &mut Formatter) -> Result
[src]
fn fmt(&self, fmt: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Display for Ipv4Net
[src]
impl Display for Ipv4Net
fn fmt(&self, fmt: &mut Formatter) -> Result
[src]
fn fmt(&self, fmt: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<'a> Contains<&'a Ipv4Net> for Ipv4Net
[src]
impl<'a> Contains<&'a Ipv4Net> for Ipv4Net
impl<'a> Contains<&'a Ipv4Addr> for Ipv4Net
[src]
impl<'a> Contains<&'a Ipv4Addr> for Ipv4Net
impl FromStr for Ipv4Net
[src]
impl FromStr for Ipv4Net
type Err = AddrParseError
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Ipv4Net, AddrParseError>
[src]
fn from_str(s: &str) -> Result<Ipv4Net, AddrParseError>
Parses a string s
to return a value of this type. Read more