Enum IpNetwork 

pub enum IpNetwork {
    V4(Ipv4Network),
    V6(Ipv6Network),
}

Holds IPv4 or IPv6 network.

Variants

V4(Ipv4Network)

V6(Ipv6Network)

Implementations

impl IpNetwork

pub fn new<I: Into<IpAddr>>( network_address: I, netmask: u8, ) -> Result<Self, IpNetworkError>

Constructs new IpNetwork based on IpAddr and netmask.

Examples

use std::net::{IpAddr, Ipv4Addr};
use std::str::FromStr;
use ip_network::{IpNetwork, Ipv4Network};

let network_address = IpAddr::V4(Ipv4Addr::new(192, 168, 1, 0));
let ip_network = IpNetwork::new(network_address, 24)?;
assert_eq!(ip_network.network_address(), IpAddr::V4(Ipv4Addr::new(192, 168, 1, 0)));
assert_eq!(ip_network.netmask(), 24);

pub fn new_truncate<I: Into<IpAddr>>( network_address: I, netmask: u8, ) -> Result<Self, IpNetworkError>

Constructs new IpNetwork based on IpAddr and netmask with truncating host bits from given network_address.

Returns error if netmask is bigger than 32 for IPv4 and 128 for IPv6.

Examples

use std::net::{IpAddr, Ipv4Addr};
use ip_network::IpNetwork;

let network_address = IpAddr::V4(Ipv4Addr::new(192, 168, 1, 128));
let ip_network = IpNetwork::new_truncate(network_address, 24)?;
assert_eq!(ip_network.network_address(), IpAddr::V4(Ipv4Addr::new(192, 168, 1, 0)));
assert_eq!(ip_network.netmask(), 24);

pub fn network_address(&self) -> IpAddr

Returns network IP address.

Examples

use std::net::{IpAddr, Ipv4Addr};
use ip_network::IpNetwork;

let ip_network = IpNetwork::new(Ipv4Addr::new(192, 168, 1, 0), 24)?;
assert_eq!(ip_network.network_address(), IpAddr::V4(Ipv4Addr::new(192, 168, 1, 0)));

pub fn netmask(&self) -> u8

Returns network mask as integer.

Examples

use std::net::{IpAddr, Ipv4Addr};
use ip_network::IpNetwork;

let ip_network = IpNetwork::new(Ipv4Addr::new(192, 168, 1, 0), 24)?;
assert_eq!(ip_network.netmask(), 24);

pub fn is_ipv4(&self) -> bool

Returns true if IpNetwork contains Ipv4Network struct.

pub fn is_ipv6(&self) -> bool

Returns true if IpNetwork contains Ipv6Network struct.

pub fn contains<I: Into<IpAddr>>(&self, ip: I) -> bool

Returns true if IpNetwork contains IpAddr. For different network type (for example IpNetwork is IPv6 and IpAddr is IPv4) always returns false.

Examples

use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use ip_network::IpNetwork;

let ip_network = IpNetwork::new(Ipv4Addr::new(192, 168, 1, 0), 24)?;
assert!(ip_network.contains(Ipv4Addr::new(192, 168, 1, 25)));
assert!(!ip_network.contains(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 1, 0, 0)));

pub fn is_default_route(&self) -> bool

Returns true if the network is default route, that contains all IP addresses.

pub fn is_multicast(&self) -> bool

Returns true if the network is part of multicast network range.

pub fn is_documentation(&self) -> bool

Returns true if this is a part of network reserved for documentation.

pub fn is_loopback(&self) -> bool

Returns true if this network is inside loopback address range.

pub fn is_global(&self) -> bool

Returns true if the network appears to be globally routable.

pub fn from_str_truncate(s: &str) -> Result<Self, IpNetworkParseError>

Converts string in format IPv4 (X.X.X.X/Y) or IPv6 (X:X::X/Y) CIDR notation to IpNetwork.

Examples

use std::net::Ipv4Addr;
use ip_network::{IpNetwork, Ipv4Network};

let ip_network = IpNetwork::from_str_truncate("192.168.1.1/24").unwrap();
assert_eq!(ip_network, IpNetwork::V4(Ipv4Network::new(Ipv4Addr::new(192, 168, 1, 0), 24).unwrap()));

pub fn collapse_addresses(addresses: &[Self]) -> Vec<Self>

Return an iterator of the collapsed IpNetworks.

Trait Implementations

impl Clone for IpNetwork

fn clone(&self) -> IpNetwork

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IpNetwork

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

Formats the value using the given formatter.

impl Display for IpNetwork

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

Converts IpNetwork to string in format X.X.X.X/Y for IPv4 and X:X::X/Y for IPv6 (CIDR notation).

Examples

use std::net::Ipv4Addr;
use ip_network::{IpNetwork, Ipv4Network};

let ip_network = IpNetwork::V4(Ipv4Network::new(Ipv4Addr::new(192, 168, 1, 0), 24)?);
assert_eq!(ip_network.to_string(), "192.168.1.0/24");

impl From<IpAddr> for IpNetwork

fn from(ip: IpAddr) -> Self

Converts IpAddr to IpNetwork with netmask 32 for IPv4 address and 128 for IPv6 address.

impl From<Ipv4Addr> for IpNetwork

fn from(ip: Ipv4Addr) -> Self

Converts Ipv4Addr to IpNetwork with netmask 32.

impl From<Ipv4Network> for IpNetwork

fn from(network: Ipv4Network) -> Self

Converts to this type from the input type.

impl From<Ipv6Addr> for IpNetwork

fn from(ip: Ipv6Addr) -> Self

Converts Ipv6Addr to IpNetwork with netmask 128.

impl From<Ipv6Network> for IpNetwork

fn from(network: Ipv6Network) -> Self

Converts to this type from the input type.

impl FromStr for IpNetwork

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

Converts string in format IPv4 (X.X.X.X/Y) or IPv6 (X:X::X/Y) CIDR notation to IpNetwork.

Examples

use std::net::Ipv4Addr;
use std::str::FromStr;
use ip_network::{IpNetwork, Ipv4Network};

let ip_network = IpNetwork::from_str("192.168.1.0/24").unwrap();
assert_eq!(ip_network, IpNetwork::V4(Ipv4Network::new(Ipv4Addr::new(192, 168, 1, 0), 24).unwrap()));

type Err = IpNetworkParseError

The associated error which can be returned from parsing.

impl Hash for IpNetwork

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for IpNetwork

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<IpNetwork> for Ipv4Network

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<IpNetwork> for Ipv6Network

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Ipv4Network> for IpNetwork

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Ipv6Network> for IpNetwork

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for IpNetwork

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<IpNetwork> for Ipv4Network

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<IpNetwork> for Ipv6Network

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<Ipv4Network> for IpNetwork

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<Ipv6Network> for IpNetwork

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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd for IpNetwork

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for IpNetwork

impl Eq for IpNetwork

impl StructuralPartialEq for IpNetwork