Struct Ifv4Net 

pub struct Ifv4Net { /* private fields */ }

An interface IPv4 network.

Implementations

impl Ifv4Net

pub const fn new(index: u32, addr: Ipv4Net) -> Self

Creates a new Ifv4Net from an Ipv4Net.

pub const fn with_prefix_len( index: u32, addr: Ipv4Addr, prefix_len: u8, ) -> Result<Self, PrefixLenError>

Creates a new IPv4interface address from an index, Ipv4Addr and prefix length.

pub const fn with_prefix_len_assert( index: u32, addr: Ipv4Addr, prefix_len: u8, ) -> Self

Creates a new IPv4 interface address from an index, Ipv4Addr and prefix length. If called from a const context it will verify prefix length at compile time. Otherwise it will panic at runtime if prefix length is not less then or equal to 32.

pub const fn index(&self) -> u32

Returns the index of the interface.

pub fn name(&self) -> Result<SmolStr>

Returns the name of the interface.

This method will invoke the if_indextoname function to get the name of the interface internally.

pub const fn addr(&self) -> Ipv4Addr

Returns the address of the interface.

pub const fn net(&self) -> &Ipv4Net

Returns the net of the interface.

pub const fn prefix_len(&self) -> u8

Returns the prefix length of the interface address.

pub const fn max_prefix_len(&self) -> u8

Returns the maximum prefix length of the interface address.

Methods from Deref<Target = Ipv4Net>

pub fn trunc(&self) -> Ipv4Net

Returns a copy of the network with the address truncated to the prefix length.

Examples

assert_eq!(
    "192.168.12.34/16".parse::<Ipv4Net>().unwrap().trunc(),
    "192.168.0.0/16".parse().unwrap()
);

pub fn addr(&self) -> Ipv4Addr

Returns the address.

pub fn prefix_len(&self) -> u8

Returns the prefix length.

pub fn max_prefix_len(&self) -> u8

Returns the maximum valid prefix length.

pub fn netmask(&self) -> Ipv4Addr

Returns the network mask.

Examples

let net: Ipv4Net = "10.1.0.0/20".parse().unwrap();
assert_eq!(Ok(net.netmask()), "255.255.240.0".parse());

pub fn hostmask(&self) -> Ipv4Addr

Returns the host mask.

Examples

let net: Ipv4Net = "10.1.0.0/20".parse().unwrap();
assert_eq!(Ok(net.hostmask()), "0.0.15.255".parse());

pub fn network(&self) -> Ipv4Addr

Returns the network address.

Examples

let net: Ipv4Net = "172.16.123.123/16".parse().unwrap();
assert_eq!(Ok(net.network()), "172.16.0.0".parse());

pub fn broadcast(&self) -> Ipv4Addr

Returns the broadcast address.

Examples

let net: Ipv4Net = "172.16.0.0/22".parse().unwrap();
assert_eq!(Ok(net.broadcast()), "172.16.3.255".parse());

pub fn supernet(&self) -> Option<Ipv4Net>

Returns the Ipv4Net that contains this one.

Examples

let n1: Ipv4Net = "172.16.1.0/24".parse().unwrap();
let n2: Ipv4Net = "172.16.0.0/23".parse().unwrap();
let n3: Ipv4Net = "172.16.0.0/0".parse().unwrap();

assert_eq!(n1.supernet().unwrap(), n2);
assert_eq!(n3.supernet(), None);

pub fn is_sibling(&self, other: &Ipv4Net) -> bool

Returns true if this network and the given network are children of the same supernet.

Examples

let n1: Ipv4Net = "10.1.0.0/24".parse().unwrap();
let n2: Ipv4Net = "10.1.1.0/24".parse().unwrap();
let n3: Ipv4Net = "10.1.2.0/24".parse().unwrap();

assert!(n1.is_sibling(&n2));
assert!(!n2.is_sibling(&n3));

pub fn hosts(&self) -> Ipv4AddrRange

Return an Iterator over the host addresses in this network.

If the prefix length is less than 31 both the network address and broadcast address are excluded. These are only valid host addresses when the prefix length is 31.

Examples

let net: Ipv4Net = "10.0.0.0/30".parse().unwrap();
assert_eq!(net.hosts().collect::<Vec<Ipv4Addr>>(), vec![
    "10.0.0.1".parse::<Ipv4Addr>().unwrap(),
    "10.0.0.2".parse().unwrap(),
]);

let net: Ipv4Net = "10.0.0.0/31".parse().unwrap();
assert_eq!(net.hosts().collect::<Vec<Ipv4Addr>>(), vec![
    "10.0.0.0".parse::<Ipv4Addr>().unwrap(),
    "10.0.0.1".parse().unwrap(),
]);

pub fn subnets(&self, new_prefix_len: u8) -> Result<Ipv4Subnets, PrefixLenError>

Returns an Iterator over the subnets of this network with the given prefix length.

Examples

let net: Ipv4Net = "10.0.0.0/24".parse().unwrap();
assert_eq!(net.subnets(26).unwrap().collect::<Vec<Ipv4Net>>(), vec![
    "10.0.0.0/26".parse::<Ipv4Net>().unwrap(),
    "10.0.0.64/26".parse().unwrap(),
    "10.0.0.128/26".parse().unwrap(),
    "10.0.0.192/26".parse().unwrap(),
]);

let net: Ipv4Net = "10.0.0.0/30".parse().unwrap();
assert_eq!(net.subnets(32).unwrap().collect::<Vec<Ipv4Net>>(), vec![
    "10.0.0.0/32".parse::<Ipv4Net>().unwrap(),
    "10.0.0.1/32".parse().unwrap(),
    "10.0.0.2/32".parse().unwrap(),
    "10.0.0.3/32".parse().unwrap(),
]);

let net: Ipv4Net = "10.0.0.0/24".parse().unwrap();
assert_eq!(net.subnets(23), Err(PrefixLenError));

let net: Ipv4Net = "10.0.0.0/24".parse().unwrap();
assert_eq!(net.subnets(33), Err(PrefixLenError));

pub fn contains<T>(&self, other: T) -> bool

where Ipv4Net: Contains<T>,

Test if a network address contains either another network address or an IP address.

Examples

let net: Ipv4Net = "192.168.0.0/24".parse().unwrap();
let net_yes: Ipv4Net = "192.168.0.0/25".parse().unwrap();
let net_no: Ipv4Net = "192.168.0.0/23".parse().unwrap();
let ip_yes: Ipv4Addr = "192.168.0.1".parse().unwrap();
let ip_no: Ipv4Addr = "192.168.1.0".parse().unwrap();

assert!(net.contains(&net));
assert!(net.contains(&net_yes));
assert!(!net.contains(&net_no));
assert!(net.contains(&ip_yes));
assert!(!net.contains(&ip_no));

Trait Implementations

impl Clone for Ifv4Net

fn clone(&self) -> Ifv4Net

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ifv4Net

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

Formats the value using the given formatter.

impl Deref for Ifv4Net

type Target = Ipv4Net

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Ifv4Net

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

Formats the value using the given formatter.

impl From<Ifv4Net> for IfNet

fn from(value: Ifv4Net) -> Self

Converts to this type from the input type.

impl Hash for Ifv4Net

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 Ifv4Net

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

fn eq(&self, other: &Ifv4Net) -> 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 for Ifv4Net

fn partial_cmp(&self, other: &Ifv4Net) -> 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 Ifv4Net

impl Eq for Ifv4Net

impl StructuralPartialEq for Ifv4Net