Struct ip_network::Ipv6Network

pub struct Ipv6Network { /* fields omitted */ }

IPv6 Network

Methods

impl Ipv6Network

pub fn from(     network_address: Ipv6Addr,     netmask: u8 ) -> Result<Self, IpNetworkError>

Constructs new Ipv6Network based on Ipv6Addr and netmask.

Returns error if netmask is bigger than 128 or if host bits are set in network_address.

Examples

use std::net::Ipv6Addr;
use ip_network::Ipv6Network;

let ip = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0);
let ip_network = Ipv6Network::from(ip, 32).unwrap();
assert_eq!(ip_network.network_address(), ip);
assert_eq!(ip_network.netmask(), 32);

pub fn from_truncate(     network_address: Ipv6Addr,     netmask: u8 ) -> Result<Self, IpNetworkError>

Constructs new Ipv6Network based on Ipv6Addr and netmask with truncating host bits from given network_address.

Returns error if netmask is bigger than 128.

Examples

use std::net::Ipv6Addr;
use ip_network::Ipv6Network;

let ip = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 1, 0, 0);
let ip_network = Ipv6Network::from_truncate(ip, 32).unwrap();
assert_eq!(ip_network.network_address(), Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0));
assert_eq!(ip_network.netmask(), 32);

pub fn network_address(&self) -> Ipv6Addr

Returns network IP address (first address in range).

Examples

use std::net::Ipv6Addr;
use ip_network::Ipv6Network;

let ip = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0);
let ip_network = Ipv6Network::from(ip, 32).unwrap();
assert_eq!(ip_network.network_address(), ip);

pub fn get_network_address(&self) -> Ipv6Addr

Deprecated since 0.2.2

: please use network_address instead

pub fn netmask(&self) -> u8

Returns network mask.

Examples

use std::net::Ipv6Addr;
use ip_network::Ipv6Network;

let ip = Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0);
let ip_network = Ipv6Network::from(ip, 32).unwrap();
assert_eq!(ip_network.netmask(), 32);

pub fn get_netmask(&self) -> u8

Deprecated since 0.2.2

: please use netmask instead

pub fn contains(&self, ip: Ipv6Addr) -> bool

Returns true if given IP address is inside this network.

Examples

use std::net::Ipv6Addr;
use ip_network::Ipv6Network;

let ip_network = Ipv6Network::from(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0), 64).unwrap();
assert!(ip_network.contains(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1)));
assert!(!ip_network.contains(Ipv6Addr::new(0x2001, 0xdb9, 0, 0, 0, 0, 0, 0)));

pub fn supernet(&self) -> Self

Returns network with smaller netmask by one.

Examples

use std::net::Ipv6Addr;
use ip_network::Ipv6Network;

let network = Ipv6Network::from(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0), 32).unwrap();
assert_eq!(network.supernet(), Ipv6Network::from(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0), 31).unwrap());

Important traits for Ipv6NetworkIterator

impl Iterator for Ipv6NetworkIterator type Item = Ipv6Network;

pub fn subnets(&self) -> Ipv6NetworkIterator

Returns Ipv6NetworkIterator over networks with netmask bigger one.

Examples

use std::net::Ipv6Addr;
use ip_network::Ipv6Network;

let network = Ipv6Network::from(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0), 32).unwrap();
let mut iterator = network.subnets();
assert_eq!(iterator.next().unwrap(), Ipv6Network::from(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0), 33).unwrap());
assert_eq!(iterator.last().unwrap(), Ipv6Network::from(Ipv6Addr::new(0x2001, 0xdb8, 0x8000, 0, 0, 0, 0, 0), 33).unwrap());

Important traits for Ipv6NetworkIterator

impl Iterator for Ipv6NetworkIterator type Item = Ipv6Network;

pub fn subnets_with_prefix(&self, prefix: u8) -> Ipv6NetworkIterator

Returns Ipv6NetworkIterator over networks with defined netmask.

Examples

use std::net::Ipv6Addr;
use ip_network::Ipv6Network;

let network = Ipv6Network::from(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0), 32).unwrap();
let mut iterator = network.subnets_with_prefix(33);
assert_eq!(iterator.next().unwrap(), Ipv6Network::from(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0), 33).unwrap());
assert_eq!(iterator.last().unwrap(), Ipv6Network::from(Ipv6Addr::new(0x2001, 0xdb8, 0x8000, 0, 0, 0, 0, 0), 33).unwrap());

Trait Implementations

impl From<Ipv6Network> for IpNetwork

fn from(network: Ipv6Network) -> IpNetwork

Performs the conversion.

impl Clone for Ipv6Network

fn clone(&self) -> Ipv6Network

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ipv6Network

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

Formats the value using the given formatter.

impl Eq for Ipv6Network

impl PartialEq for Ipv6Network

fn eq(&self, other: &Ipv6Network) -> bool

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

fn ne(&self, other: &Ipv6Network) -> bool

This method tests for !=.

impl Hash for Ipv6Network

fn hash<__H: Hasher>(&self, state: &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 PartialOrd for Ipv6Network

fn partial_cmp(&self, other: &Ipv6Network) -> Option<Ordering>

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

fn lt(&self, other: &Ipv6Network) -> bool

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

fn le(&self, other: &Ipv6Network) -> bool

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

fn gt(&self, other: &Ipv6Network) -> bool

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

fn ge(&self, other: &Ipv6Network) -> bool

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

impl Ord for Ipv6Network

fn cmp(&self, other: &Ipv6Network) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Display for Ipv6Network

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

Converts Ipv6Network to string in format X:X::X/Y (CIDR notation).

Examples

use std::net::Ipv6Addr;
use ip_network::Ipv6Network;

let ip_network = Ipv6Network::from(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0), 32).unwrap();
assert_eq!(format!("{}", ip_network), "2001:db8::/32");

impl FromStr for Ipv6Network

type Err = IpNetworkParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Ipv6Network, IpNetworkParseError>

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