Struct net_adds::Ipv4AddrNetwork

pub struct Ipv4AddrNetwork { /* fields omitted */ }

An IPv4 address network.

See crate::IpAddrNetwork for a type encompassing both IPv4 and IPv6 network.

The size of an Ipv4AddrNetwork struct may vary depending on the target operating system.

Textual representation

Ipv4AddrNetwork provides a FromStr implementation. The two parts are divided by /. The first part must contain an IPv4. The second part can either contain an IPv4 or an u8 between 0 and 32 which is valid as a netmask prefix.

Examples

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

let ip = Ipv4Addr::new(192, 168, 0, 10);
let network = Ipv4AddrNetwork::try_new(ip, 24).unwrap();

assert_eq!(Ok(network), "192.168.0.10/255.255.255.0".parse());
assert_eq!(Ok(network), "192.168.0.10/24".parse());

let netmask = Ipv4Addr::new(255, 255, 255, 0);
let networkb = Ipv4AddrNetwork::try_new_with_addr(ip, netmask).unwrap();

assert_eq!(networkb, network);
assert_eq!(Ok(networkb), "192.168.0.10/255.255.255.0".parse());
assert_eq!(Ok(networkb), "192.168.0.10/24".parse());

Implementations

impl Ipv4AddrNetwork

pub fn try_new(
    ip: Ipv4Addr,
    prefix: u8
) -> Result<Ipv4AddrNetwork, NetAddsError>

Returns an IPv4 network.

If the netmask is not valid return an NetAddsError::InvalidNetmaskPrefix(InvalidNetmaskPrefixError).

pub fn try_new_with_addr(
    ip: Ipv4Addr,
    netmask: Ipv4Addr
) -> Result<Ipv4AddrNetwork, NetAddsError>

Returns an IPv4 network.

If the netmask is not valid return an NetAddsError::InvalidNetmask(InvalidNetmaskError).

pub fn ip(self) -> Ipv4Addr

Returns the ip addr.

pub fn prefix(self) -> u8

Returns the netmask prefix.

pub fn netmask(self) -> Ipv4Addr

Returns the netmask addr.

pub fn network(self) -> Ipv4Addr

Returns the network addr.

pub fn broadcast(self) -> Ipv4Addr

Returns the broadcast addr.

pub fn all(&self) -> Vec<Ipv4Addr>

Returns all ip of the network including the network and the broadcast addr.

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

let network = Ipv4AddrNetwork::try_new(Ipv4Addr::new(192, 168, 0, 10), 30).unwrap();

assert_eq!(network.all(), vec![
    Ipv4Addr::new(192, 168, 0, 8),
    Ipv4Addr::new(192, 168, 0, 9),
    Ipv4Addr::new(192, 168, 0, 10),
    Ipv4Addr::new(192, 168, 0, 11)
]);

pub fn hosts(&self) -> Vec<Ipv4Addr>

Returns all hosts (exclude network & broadcast addr).

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

let network = Ipv4AddrNetwork::try_new(Ipv4Addr::new(192, 168, 0, 10), 30).unwrap();

assert_eq!(network.hosts(), vec![
    Ipv4Addr::new(192, 168, 0, 9),
    Ipv4Addr::new(192, 168, 0, 10)
]);

pub fn size(&self) -> u32

Returns the number of ip’s included in the network including the network and the broadcast addr.

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

let network = Ipv4AddrNetwork::try_new(Ipv4Addr::new(192, 168, 0, 10), 24).unwrap();

assert_eq!(network.size(), 256);

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

Returns true if the ip argument is included in the network, else returns false.

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

let network = Ipv4AddrNetwork::try_new(Ipv4Addr::new(192, 168, 0, 10), 24).unwrap();

assert!(network.has(Ipv4Addr::new(192, 168, 0, 0)));
assert!(network.has(Ipv4Addr::new(192, 168, 0, 142)));
assert!(network.has(Ipv4Addr::new(192, 168, 0, 255)));

assert!(!network.has(Ipv4Addr::new(192, 169, 0, 0)));

pub fn validate_netmask(netmask: u32) -> Result<u32, NetAddsError>

Check the validity of a netmask under Ipv4Addr representation.

If the netmask is not valid return an NetAddsError::InvalidNetmask(InvalidNetmaskError).

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

let netmask = Ipv4Addr::new(255, 255, 255, 0);
assert_eq!(Ipv4AddrNetwork::validate_netmask(u32::from(netmask)), Ok(u32::from(netmask)));

let netmask = Ipv4Addr::new(0, 0, 0, 255);
assert!(Ipv4AddrNetwork::validate_netmask(u32::from(netmask)).is_err());

pub fn validate_prefix(prefix: u8) -> Result<u8, NetAddsError>

Check the validity of a netmask under CIDR prefix representation.

If the netmask prefix is not valid return an NetAddsError::InvalidNetmaskPrefix(InvalidNetmaskPrefixError).

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

assert_eq!(Ipv4AddrNetwork::validate_prefix(32), Ok(32));

assert!(Ipv4AddrNetwork::validate_prefix(33).is_err());

pub fn prefix_to_ip(prefix: u8) -> Result<u32, NetAddsError>

Returns the Ipv4Addr representation of a CIDR prefix.

If the netmask prefix is not valid return an NetAddsError::InvalidNetmaskPrefix(InvalidNetmaskPrefixError).

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

assert_eq!(Ipv4AddrNetwork::prefix_to_ip(0), Ok(0));
assert_eq!(Ipv4AddrNetwork::prefix_to_ip(32), Ok(u32::MAX));

assert!(Ipv4AddrNetwork::prefix_to_ip(33).is_err());

pub fn ip_to_prefix(ip: u32) -> Result<u8, NetAddsError>

Returns the CIDR prefix representation of an Ipv4Addr.

We count the bit that are equals to 0 by shifting the sequence to the right (bitwise >>). Then we subtract the number of bits equal to 0 from the maximum number of bits available on the netmask.

If the netmask is not valid return an NetAddsError::InvalidNetmask(InvalidNetmaskError).

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

assert_eq!(Ipv4AddrNetwork::ip_to_prefix(u32::from(Ipv4Addr::new(0, 0, 0, 0))), Ok(0));
assert_eq!(Ipv4AddrNetwork::ip_to_prefix(u32::from(Ipv4Addr::new(255, 255, 255, 255))), Ok(32));

assert!(Ipv4AddrNetwork::ip_to_prefix(u32::from(Ipv4Addr::new(0, 255, 255, 255))).is_err());

Trait Implementations

impl Clone for Ipv4AddrNetwork

fn clone(&self) -> Ipv4AddrNetwork

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ipv4AddrNetwork

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

Formats the value using the given formatter.

impl Display for Ipv4AddrNetwork

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

Formats the value using the given formatter.

impl From<Ipv4AddrNetwork> for IpAddrNetwork

fn from(network: Ipv4AddrNetwork) -> IpAddrNetwork

Create an IpAddrNetwork::V4 from an Ipv4AddrNetwork.

Examples:

use std::net::Ipv4Addr;

use net_adds::{IpAddrNetwork, Ipv4AddrNetwork};

let network = Ipv4AddrNetwork::try_new(Ipv4Addr::new(192, 168, 0, 10), 24).unwrap();

assert_eq!(IpAddrNetwork::from(network), IpAddrNetwork::V4(network));

impl FromStr for Ipv4AddrNetwork

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a string as Ipv4AddrNetwork.

If the string representation is not valid return an NetAddsErrorAddrParse(NetworkAddrParseError).

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

let network = Ipv4AddrNetwork::try_new(Ipv4Addr::new(192, 168, 0, 10), 24);

assert_eq!("192.168.0.10/24".parse(), network);
assert_eq!("192.168.0.10/255.255.255.0".parse(), network);

type Err = NetAddsError

The associated error which can be returned from parsing.

impl Hash for Ipv4AddrNetwork

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 IntoIterator for Ipv4AddrNetwork

fn into_iter(self) -> Self::IntoIter

Create a Ipv4Addr iterator. The iterator include the network and the broadcast.

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

let mut iter = Ipv4AddrNetwork::try_new(Ipv4Addr::new(192, 168, 0, 0), 30)
    .expect("invalid network")
    .into_iter();

assert_eq!(iter.next(), Some(Ipv4Addr::new(192, 168, 0, 0)));
assert_eq!(iter.next(), Some(Ipv4Addr::new(192, 168, 0, 1)));
assert_eq!(iter.next(), Some(Ipv4Addr::new(192, 168, 0, 2)));
assert_eq!(iter.next(), Some(Ipv4Addr::new(192, 168, 0, 3)));
assert_eq!(iter.next(), None);

type Item = Ipv4Addr

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

impl IntoSmartIterator for Ipv4AddrNetwork

fn into_smart_iter(self) -> Self::IntoSmartIter

Create a smart Ipv4Addr iterator. The iterator include the network and the broadcast.

Examples:

use std::net::Ipv4Addr;

use net_adds::{Ipv4AddrNetwork, IntoSmartIterator};

let mut iter = Ipv4AddrNetwork::try_new(Ipv4Addr::new(192, 168, 0, 0), 30)
    .expect("invalid network")
    .into_smart_iter();

assert_eq!(iter.next(), Some(Ipv4Addr::new(192, 168, 0, 0)));
assert_eq!(iter.next(), Some(Ipv4Addr::new(192, 168, 0, 1)));
assert_eq!(iter.next(), Some(Ipv4Addr::new(192, 168, 0, 2)));
assert_eq!(iter.next(), Some(Ipv4Addr::new(192, 168, 0, 3)));
assert_eq!(iter.next(), None);

type Item = Ipv4Addr

The type of the elements being iterated over.

type IntoSmartIter = Ipv4AddrSmartIterator

Which kind of iterator are we turning this into?

impl Ord for Ipv4AddrNetwork

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

Restrict a value to a certain interval.

impl PartialEq<Ipv4AddrNetwork> for Ipv4AddrNetwork

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

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

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

This method tests for !=.

impl PartialOrd<Ipv4AddrNetwork> for Ipv4AddrNetwork

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

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

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

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

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

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

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

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

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

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

impl TryFrom<(Ipv4Addr, Ipv4Addr)> for Ipv4AddrNetwork

fn try_from(ips: (Ipv4Addr, Ipv4Addr)) -> Result<Ipv4AddrNetwork, Self::Error>

Create an Ipv4AddrNetwork from a tuple of two Ipv4Addr.

Examples:

use std::convert::TryFrom;
use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

let ip = Ipv4Addr::new(192, 168, 0, 10);

let netmask = Ipv4Addr::new(255, 255, 255, 0);
assert_eq!(Ipv4AddrNetwork::try_from((ip, netmask)), Ipv4AddrNetwork::try_new(ip, 24));

let netmask = Ipv4Addr::new(255, 255, 117, 0);
assert!(Ipv4AddrNetwork::try_from((ip, netmask)).is_err());

type Error = NetAddsError

The type returned in the event of a conversion error.

impl TryFrom<(Ipv4Addr, u8)> for Ipv4AddrNetwork

fn try_from(
    (ip, prefix): (Ipv4Addr, u8)
) -> Result<Ipv4AddrNetwork, Self::Error>

Create an Ipv4AddrNetwork from a tuple of two slots, Ipv4Addr and u8.

If the netmask prefix is not valid return an NetAddsError::InvalidNetmaskPrefix(InvalidNetmaskPrefixError).

Examples:

use std::convert::TryFrom;
use std::net::Ipv4Addr;

use net_adds::Ipv4AddrNetwork;

let ip = Ipv4Addr::new(192, 168, 0, 10);

assert_eq!(Ipv4AddrNetwork::try_from((ip, 24)), Ipv4AddrNetwork::try_new(ip, 24));

assert!(Ipv4AddrNetwork::try_from((ip, 33)).is_err());

type Error = NetAddsError

The type returned in the event of a conversion error.

impl Copy for Ipv4AddrNetwork

impl Eq for Ipv4AddrNetwork

impl StructuralEq for Ipv4AddrNetwork

impl StructuralPartialEq for Ipv4AddrNetwork