Struct ipnetwork::Ipv4Network

pub struct Ipv4Network { /* fields omitted */ }

Represents a network range where the IP addresses are of v4

Methods

impl Ipv4Network

pub fn new(addr: Ipv4Addr, prefix: u8) -> Result<Ipv4Network, IpNetworkError>

Constructs a new Ipv4Network from any Ipv4Addr and a prefix denoting the network size. If the prefix is larger than 32 this will return an IpNetworkError::InvalidPrefix.

pub fn iter(&self) -> Ipv4NetworkIterator

Returns an iterator over Ipv4Network. Each call to next will return the next Ipv4Addr in the given network. None will be returned when there are no more addresses.

pub fn ip(&self) -> Ipv4Addr

pub fn prefix(&self) -> u8

pub fn is_subnet_of(self, other: Ipv4Network) -> bool

Checks if the given Ipv4Network is a subnet of the other.

pub fn is_supernet_of(self, other: Ipv4Network) -> bool

Checks if the given Ipv4Network is a supernet of the other.

pub fn overlaps(self, other: Ipv4Network) -> bool

Checks if the given Ipv4Network is partly contained in other.

pub fn mask(&self) -> Ipv4Addr

Returns the mask for this Ipv4Network. That means the prefix most significant bits will be 1 and the rest 0

Examples

use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;

let net: Ipv4Network = "127.0.0.0".parse().unwrap();
assert_eq!(net.mask(), Ipv4Addr::new(255, 255, 255, 255));
let net: Ipv4Network = "127.0.0.0/16".parse().unwrap();
assert_eq!(net.mask(), Ipv4Addr::new(255, 255, 0, 0));

pub fn network(&self) -> Ipv4Addr

Returns the address of the network denoted by this Ipv4Network. This means the lowest possible IPv4 address inside of the network.

Examples

use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;

let net: Ipv4Network = "10.1.9.32/16".parse().unwrap();
assert_eq!(net.network(), Ipv4Addr::new(10, 1, 0, 0));

pub fn broadcast(&self) -> Ipv4Addr

Returns the broadcasting address of this Ipv4Network. This means the highest possible IPv4 address inside of the network.

Examples

use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;

let net: Ipv4Network = "10.9.0.32/16".parse().unwrap();
assert_eq!(net.broadcast(), Ipv4Addr::new(10, 9, 255, 255));

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

Checks if a given Ipv4Addr is in this Ipv4Network

Examples

use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;

let net: Ipv4Network = "127.0.0.0/24".parse().unwrap();
assert!(net.contains(Ipv4Addr::new(127, 0, 0, 70)));
assert!(!net.contains(Ipv4Addr::new(127, 0, 1, 70)));

pub fn size(&self) -> u32

Returns number of possible host addresses in this Ipv4Network.

Examples

use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;

let net: Ipv4Network = "10.1.0.0/16".parse().unwrap();
assert_eq!(net.size(), 65536);

let tinynet: Ipv4Network = "0.0.0.0/32".parse().unwrap();
assert_eq!(tinynet.size(), 1);

pub fn nth(&self, n: u32) -> Option<Ipv4Addr>

Returns the n:th address within this network. The adresses are indexed from 0 and n must be smaller than the size of the network.

Examples

use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;

let net: Ipv4Network = "192.168.0.0/24".parse().unwrap();
assert_eq!(net.nth(0).unwrap(), Ipv4Addr::new(192, 168, 0, 0));
assert_eq!(net.nth(15).unwrap(), Ipv4Addr::new(192, 168, 0, 15));
assert!(net.nth(256).is_none());

let net2: Ipv4Network = "10.0.0.0/16".parse().unwrap();
assert_eq!(net2.nth(256).unwrap(), Ipv4Addr::new(10, 0, 1, 0));

Trait Implementations

impl From<Ipv4Addr> for Ipv4Network

fn from(a: Ipv4Addr) -> Ipv4Network

Performs the conversion.

impl From<Ipv4Network> for IpNetwork

fn from(v4: Ipv4Network) -> IpNetwork

Performs the conversion.

impl Clone for Ipv4Network

fn clone(&self) -> Ipv4Network

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Ipv4Network> for Ipv4Network

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

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

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

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

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

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

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

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

impl Copy for Ipv4Network

impl Eq for Ipv4Network

impl Ord for Ipv4Network

fn cmp(&self, other: &Ipv4Network) -> 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.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Ipv4Network> for Ipv4Network

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

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

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

This method tests for !=.

impl Debug for Ipv4Network

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

Formats the value using the given formatter.

impl Display for Ipv4Network

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

Formats the value using the given formatter.

impl FromStr for Ipv4Network

Creates an Ipv4Network from parsing a string in CIDR notation.

Examples

use std::net::Ipv4Addr;
use ipnetwork::Ipv4Network;

let new = Ipv4Network::new(Ipv4Addr::new(10, 1, 9, 32), 16).unwrap();
let from_cidr: Ipv4Network = "10.1.9.32/16".parse().unwrap();
assert_eq!(new.ip(), from_cidr.ip());
assert_eq!(new.prefix(), from_cidr.prefix());

type Err = IpNetworkError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Ipv4Network, IpNetworkError>

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

impl Hash for Ipv4Network

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 Serialize for Ipv4Network

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Ipv4Network

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.