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. This is represented
using the FromStr
implementation for Ipv4Addr
followed by a /
character and the prefix length in decimal. See [IETF RFC 4632] for
the CIDR notation.
Examples
use std::net::Ipv4Addr; use std::str::FromStr; use ipnet::Ipv4Net; let net_v4 = Ipv4Net::from_str("10.1.1.0/24").unwrap(); assert_eq!("10.1.1.0".parse(), Ok(net_v4.network()));
Methods
impl Ipv4Net
[src]
fn new(ip: Ipv4Addr, prefix_len: u8) -> Ipv4Net
[src]
Creates a new IPv4 network address from an Ipv4Addr
and prefix
length.
If prefix_len
is greater than 32 it will be clamped to 32.
Examples
let net = Ipv4Net::new(Ipv4Addr::new(10, 1, 1, 0), 24);
fn prefix_len(&self) -> u8
[src]
Returns the prefix length.
fn netmask(&self) -> Ipv4Addr
[src]
Returns the network mask.
Examples
let net = Ipv4Net::from_str("10.1.0.0/20").unwrap(); assert_eq!(net.netmask(), Ipv4Addr::from_str("255.255.240.0").unwrap());
fn hostmask(&self) -> Ipv4Addr
[src]
Returns the host mask.
Examples
let net = Ipv4Net::from_str("10.1.0.0/20").unwrap(); assert_eq!(net.hostmask(), Ipv4Addr::from_str("0.0.15.255").unwrap());
fn network(&self) -> Ipv4Addr
[src]
Returns the network address.
Examples
let net = Ipv4Net::from_str("172.16.123.123/16").unwrap(); assert_eq!(net.network(), Ipv4Addr::from_str("172.16.0.0").unwrap());
fn broadcast(&self) -> Ipv4Addr
[src]
Returns the broadcast address. Returns the provided Ipv4Addr with all bits after the prefix length set.
Examples
let net = Ipv4Net::from_str("172.16.0.0/22").unwrap(); assert_eq!(net.broadcast(), Ipv4Addr::from_str("172.16.3.255").unwrap());
fn trunc(&self) -> Ipv4Net
[src]
Return a copy of the network with the address truncated to the prefix length.
Examples
assert_eq!( Ipv4Net::from_str("192.168.1.2/16").unwrap().trunc(), Ipv4Net::from_str("192.168.0.0/16").unwrap() );
fn supernet(&self) -> Option<Ipv4Net>
[src]
Returns the Ipv4Net
that contains this one.
Examples
assert_eq!( Ipv4Net::from_str("172.16.1.0/24").unwrap() .supernet().unwrap().trunc(), Ipv4Net::from_str("172.16.0.0/23").unwrap() );
fn is_sibling(&self, other: &Ipv4Net) -> bool
[src]
Returns true
if this network and the given network are
children of the same supernet.
Examples
let net1 = Ipv4Net::from_str("10.1.0.0/24").unwrap(); let net2 = Ipv4Net::from_str("10.1.1.0/24").unwrap(); let net3 = Ipv4Net::from_str("10.1.2.0/24").unwrap(); assert!(net1.is_sibling(&net2)); assert!(!net2.is_sibling(&net3));
fn hosts(&self) -> IpAddrIter<Ipv4Addr>
[src]
Return an Iterator
over the host addresses in this network.
- For networks that have a prefix length less than 31 both the network and broadcast addresses are excluded. These are considered invalid for use as host addresses except when the prefix length is 31.
Examples
let net = Ipv4Net::from_str("10.0.0.0/30").unwrap(); assert_eq!(net.hosts().collect::<Vec<Ipv4Addr>>(), vec![ Ipv4Addr::from_str("10.0.0.1").unwrap(), Ipv4Addr::from_str("10.0.0.2").unwrap(), ]); let net = Ipv4Net::from_str("10.0.0.0/31").unwrap(); assert_eq!(net.hosts().collect::<Vec<Ipv4Addr>>(), vec![ Ipv4Addr::from_str("10.0.0.0").unwrap(), Ipv4Addr::from_str("10.0.0.1").unwrap(), ]);
fn subnets(&self, new_prefix_len: u8) -> IpNetIter<Ipv4Net>
[src]
Returns an Iterator
over the subnets of this network with the
given prefix length.
If new_prefix_len
is greater than 32 it will be clamped to 32.
Examples
let net = Ipv4Net::from_str("10.0.0.0/24").unwrap(); assert_eq!(net.subnets(26).collect::<Vec<Ipv4Net>>(), vec![ Ipv4Net::from_str("10.0.0.0/26").unwrap(), Ipv4Net::from_str("10.0.0.64/26").unwrap(), Ipv4Net::from_str("10.0.0.128/26").unwrap(), Ipv4Net::from_str("10.0.0.192/26").unwrap(), ]); let net = Ipv4Net::from_str("10.0.0.0/30").unwrap(); assert_eq!(net.subnets(32).collect::<Vec<Ipv4Net>>(), vec![ Ipv4Net::from_str("10.0.0.0/32").unwrap(), Ipv4Net::from_str("10.0.0.1/32").unwrap(), Ipv4Net::from_str("10.0.0.2/32").unwrap(), Ipv4Net::from_str("10.0.0.3/32").unwrap(), ]); let net = Ipv4Net::from_str("10.0.0.0/24").unwrap(); assert_eq!(net.subnets(23).collect::<Vec<Ipv4Net>>(), vec![]);
fn aggregate(networks: &Vec<Ipv4Net>) -> Vec<Ipv4Net>
[src]
Aggregate a Vec
of Ipv4Net
s and return the result as a new
Vec
.
Methods from Deref<Target = Ipv4Addr>
fn octets(&self) -> [u8; 4]
1.0.0[src]
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]);
fn is_unspecified(&self) -> bool
1.12.0[src]
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);
fn is_loopback(&self) -> bool
1.7.0[src]
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);
fn is_private(&self) -> bool
1.7.0[src]
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);
fn is_link_local(&self) -> bool
1.7.0[src]
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);
fn is_global(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
)
extra functionality has not been scrutinized to the level that it should 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); }
fn is_multicast(&self) -> bool
1.7.0[src]
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);
fn is_broadcast(&self) -> bool
1.7.0[src]
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);
fn is_documentation(&self) -> bool
1.7.0[src]
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);
fn to_ipv6_compatible(&self) -> Ipv6Addr
1.0.0[src]
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));
fn to_ipv6_mapped(&self) -> Ipv6Addr
1.0.0[src]
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 Clone for Ipv4Net
[src]
fn clone(&self) -> Ipv4Net
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Eq for Ipv4Net
[src]
impl PartialEq for Ipv4Net
[src]
fn eq(&self, __arg_0: &Ipv4Net) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Ipv4Net) -> bool
[src]
This method tests for !=
.
impl Hash for Ipv4Net
[src]
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
[src]
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]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl PartialOrd for Ipv4Net
[src]
fn partial_cmp(&self, __arg_0: &Ipv4Net) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Ipv4Net) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Ipv4Net) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &Ipv4Net) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Ipv4Net) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for Ipv4Net
[src]
fn cmp(&self, __arg_0: &Ipv4Net) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
[src]
ord_max_min
)Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
[src]
ord_max_min
)Compares and returns the minimum of two values. Read more
impl Deref for Ipv4Net
[src]
type Target = Ipv4Addr
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
Dereferences the value.
impl Debug for Ipv4Net
[src]
impl Display for Ipv4Net
[src]
fn fmt(&self, fmt: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<'a> Contains<&'a Ipv4Net> for Ipv4Net
[src]
fn contains(&self, other: &'a Ipv4Net) -> bool
[src]
Returns true
if this network contains the given network or address. Read more
impl<'a> Contains<&'a Ipv4Addr> for Ipv4Net
[src]
fn contains(&self, other: &'a Ipv4Addr) -> bool
[src]
Returns true
if this network contains the given network or address. Read more
impl FromStr for Ipv4Net
[src]
type Err = AddrParseError
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Ipv4Net, AddrParseError>
[src]
Parses a string s
to return a value of this type. Read more