Struct ipnet::Ipv6Net
[−]
[src]
pub struct Ipv6Net { /* fields omitted */ }
An IPv6 network address.
See IpNet
for a type encompassing both IPv4 and IPv6 network
addresses.
Textual representation
Ipv6Net
provides a FromStr
implementation. This is represented
using the FromStr
implementation for Ipv6Addr
followed by a /
character and the prefix length in decimal. See IETF RFC 4632 for
the CIDR notation.
Examples
use std::net::Ipv6Addr; use std::str::FromStr; use ipnet::Ipv6Net; let net_v6 = Ipv6Net::from_str("fd00::/32").unwrap(); assert_eq!("fd00::".parse(), Ok(net_v6.network()));
Methods
impl Ipv6Net
[src]
fn new(ip: Ipv6Addr, prefix_len: u8) -> Ipv6Net
[src]
Creates a new IPv4 network address from an Ipv4Addr
and prefix
length.
If prefix_len
is greater than 128 it will be clamped to 128.
Examples
let net = Ipv6Net::new(Ipv6Addr::from_str("fd00::").unwrap(), 24);
fn prefix_len(&self) -> u8
[src]
Returns the prefix length.
fn truncated(&self) -> Ipv6Net
[src]
Experimental.
fn netmask(&self) -> Ipv6Addr
[src]
Returns the network mask.
Examples
let net = Ipv6Net::from_str("fd00::/24").unwrap(); assert_eq!(net.netmask(), Ipv6Addr::from_str("ffff:ff00::").unwrap());
fn hostmask(&self) -> Ipv6Addr
[src]
Returns the host mask.
Examples
let net = Ipv6Net::from_str("fd00::/24").unwrap(); assert_eq!(net.hostmask(), Ipv6Addr::from_str("::ff:ffff:ffff:ffff:ffff:ffff:ffff").unwrap());
fn network(&self) -> Ipv6Addr
[src]
Returns the network address. Truncates the provided Ipv6Addr to the prefix length.
Examples
let net = Ipv6Net::from_str("fd00:1234:5678::/24").unwrap(); assert_eq!(net.network(), Ipv6Addr::from_str("fd00:1200::").unwrap());
fn broadcast(&self) -> Ipv6Addr
[src]
Returns the broadcast address. Returns the provided Ipv6Addr with all bits after the prefix length set.
- Technically there is no such thing as a broadcast address in in IPv6. Perhaps we should change the methods to first() and last() or start() and end().
Examples
let net = Ipv6Net::from_str("fd00:1234:5678::/24").unwrap(); assert_eq!(net.broadcast(), Ipv6Addr::from_str("fd00:12ff:ffff:ffff:ffff:ffff:ffff:ffff").unwrap());
fn supernet(&self) -> Ipv6Net
[src]
Returns the Ipv6Net
that contains this one.
Examples
let net = Ipv6Net::from_str("fd00:ff00::/24").unwrap(); assert_eq!(net.supernet().network(), Ipv6Addr::from_str("fd00:fe00::").unwrap());
fn subnets(&self, new_prefix_len: u8) -> Ipv6NetIter
[src]
Returns an Iterator
over the subnets of this network with the
given prefix length.
If new_prefix_len
is less than the current prefix length or
greater than 128 it will be clamped to both respectively.
Examples
let net = Ipv6Net::from_str("fd00::/16").unwrap(); assert_eq!( net.subnets(18).collect::<Vec<Ipv6Net>>(), vec![ Ipv6Net::from_str("fd00::/18").unwrap(), Ipv6Net::from_str("fd00:4000::/18").unwrap(), Ipv6Net::from_str("fd00:8000::/18").unwrap(), Ipv6Net::from_str("fd00:c000::/18").unwrap(), ] ); let net = Ipv6Net::from_str("fd00::/126").unwrap(); assert_eq!( net.subnets(128).collect::<Vec<Ipv6Net>>(), vec![ Ipv6Net::from_str("fd00::/128").unwrap(), Ipv6Net::from_str("fd00::1/128").unwrap(), Ipv6Net::from_str("fd00::2/128").unwrap(), Ipv6Net::from_str("fd00::3/128").unwrap(), ] );
fn hosts(&self) -> IpAddrIter<Ipv6Addr>
[src]
Return an Iterator
over the host addresses in this network.
fn sibling_of(&self, other: &Ipv6Net) -> bool
[src]
Returns true
if this network and the given network are both in
the same supernet.
Examples
let net1 = Ipv6Net::from_str("fd00::/18").unwrap(); let net2 = Ipv6Net::from_str("fd00:4000::/18").unwrap(); let net3 = Ipv6Net::from_str("fd00:8000::/18").unwrap(); assert!(net1.sibling_of(&net2)); assert!(!net2.sibling_of(&net3));
fn aggregate(networks: &Vec<Ipv6Net>) -> Vec<Ipv6Net>
[src]
Experimental.
Methods from Deref<Target = Ipv6Addr>
fn segments(&self) -> [u16; 8]
1.0.0[src]
Returns the eight 16-bit segments that make up this address.
Examples
use std::net::Ipv6Addr; assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).segments(), [0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff]);
fn is_unspecified(&self) -> bool
1.7.0[src]
Returns true
for the special 'unspecified' address (::).
This property is defined in IETF RFC 4291.
Examples
use std::net::Ipv6Addr; assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unspecified(), false); assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).is_unspecified(), true);
fn is_loopback(&self) -> bool
1.7.0[src]
Returns true
if this is a loopback address (::1).
This property is defined in IETF RFC 4291.
Examples
use std::net::Ipv6Addr; assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_loopback(), false); assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_loopback(), true);
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.
The following return false
:
- the loopback address
- link-local, site-local, and unique local unicast addresses
- interface-, link-, realm-, admin- and site-local multicast addresses
Examples
#![feature(ip)] use std::net::Ipv6Addr; fn main() { assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_global(), true); assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0x1).is_global(), false); assert_eq!(Ipv6Addr::new(0, 0, 0x1c9, 0, 0, 0xafc8, 0, 0x1).is_global(), true); }
fn is_unique_local(&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 this is a unique local address (fc00::/7).
This property is defined in IETF RFC 4193.
Examples
#![feature(ip)] use std::net::Ipv6Addr; fn main() { assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unique_local(), false); assert_eq!(Ipv6Addr::new(0xfc02, 0, 0, 0, 0, 0, 0, 0).is_unique_local(), true); }
fn is_unicast_link_local(&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 is unicast and link-local (fe80::/10).
This property is defined in IETF RFC 4291.
Examples
#![feature(ip)] use std::net::Ipv6Addr; fn main() { assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_link_local(), false); assert_eq!(Ipv6Addr::new(0xfe8a, 0, 0, 0, 0, 0, 0, 0).is_unicast_link_local(), true); }
fn is_unicast_site_local(&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 this is a deprecated unicast site-local address
(fec0::/10).
Examples
#![feature(ip)] use std::net::Ipv6Addr; fn main() { assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_site_local(), false); assert_eq!(Ipv6Addr::new(0xfec2, 0, 0, 0, 0, 0, 0, 0).is_unicast_site_local(), true); }
fn is_documentation(&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 this is an address reserved for documentation
(2001:db8::/32).
This property is defined in IETF RFC 3849.
Examples
#![feature(ip)] use std::net::Ipv6Addr; fn main() { assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_documentation(), false); assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_documentation(), true); }
fn is_unicast_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 is a globally routable unicast address.
The following return false:
- the loopback address
- the link-local addresses
- the (deprecated) site-local addresses
- unique local addresses
- the unspecified address
- the address range reserved for documentation
Examples
#![feature(ip)] use std::net::Ipv6Addr; fn main() { assert_eq!(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0).is_unicast_global(), false); assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_unicast_global(), true); }
fn multicast_scope(&self) -> Option<Ipv6MulticastScope>
[src]
🔬 This is a nightly-only experimental API. (ip
)
extra functionality has not been scrutinized to the level that it should be stable
Returns the address's multicast scope if the address is multicast.
Examples
#![feature(ip)] use std::net::{Ipv6Addr, Ipv6MulticastScope}; fn main() { assert_eq!(Ipv6Addr::new(0xff0e, 0, 0, 0, 0, 0, 0, 0).multicast_scope(), Some(Ipv6MulticastScope::Global)); assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).multicast_scope(), None); }
fn is_multicast(&self) -> bool
1.7.0[src]
Returns true
if this is a multicast address (ff00::/8).
This property is defined by IETF RFC 4291.
Examples
use std::net::Ipv6Addr; assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).is_multicast(), true); assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).is_multicast(), false);
fn to_ipv4(&self) -> Option<Ipv4Addr>
1.0.0[src]
Converts this address to an IPv4 address. Returns None
if this address is
neither IPv4-compatible or IPv4-mapped.
::a.b.c.d and ::ffff:a.b.c.d become a.b.c.d
Examples
use std::net::{Ipv4Addr, Ipv6Addr}; assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).to_ipv4(), None); assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x2ff).to_ipv4(), Some(Ipv4Addr::new(192, 10, 2, 255))); assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1).to_ipv4(), Some(Ipv4Addr::new(0, 0, 0, 1)));
fn octets(&self) -> [u8; 16]
1.12.0[src]
Returns the sixteen eight-bit integers the IPv6 address consists of.
use std::net::Ipv6Addr; assert_eq!(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0).octets(), [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
Trait Implementations
impl Copy for Ipv6Net
[src]
impl Clone for Ipv6Net
[src]
fn clone(&self) -> Ipv6Net
[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 Ipv6Net
[src]
impl PartialEq for Ipv6Net
[src]
fn eq(&self, __arg_0: &Ipv6Net) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Ipv6Net) -> bool
[src]
This method tests for !=
.
impl Hash for Ipv6Net
[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 Ipv6Net
[src]
fn partial_cmp(&self, __arg_0: &Ipv6Net) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Ipv6Net) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Ipv6Net) -> 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: &Ipv6Net) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Ipv6Net) -> 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 Ipv6Net
[src]
fn cmp(&self, __arg_0: &Ipv6Net) -> 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 Ipv6Net
[src]
type Target = Ipv6Addr
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
Dereferences the value.
impl Debug for Ipv6Net
[src]
impl Display for Ipv6Net
[src]
fn fmt(&self, fmt: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<'a> Contains<&'a Ipv6Net> for Ipv6Net
[src]
fn contains(&self, other: &'a Ipv6Net) -> bool
[src]
Returns true
if this network contains the given network or address. Read more
impl<'a> Contains<&'a Ipv6Addr> for Ipv6Net
[src]
fn contains(&self, other: &'a Ipv6Addr) -> bool
[src]
Returns true
if this network contains the given network or address. Read more
impl FromStr for Ipv6Net
[src]
type Err = AddrParseError
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Ipv6Net, AddrParseError>
[src]
Parses a string s
to return a value of this type. Read more