Struct net_adds::Ipv4AddrRange

pub struct Ipv4AddrRange { /* fields omitted */ }

An IPv4 address range.

See crate::IpAddrRange for a type encompassing both IPv4 and IPv6 range.

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

Textual representation

Ipv4AddrRange provides a FromStr implementation. The two parts are represented by Ipv4Addr and are separated by ‘-’.

Examples

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrRange;

let a = Ipv4Addr::new(192, 168, 0, 0);
let b = Ipv4Addr::new(192, 168, 0, 255);
let range = Ipv4AddrRange::new(a, b);

assert_eq!(Ok(range), "192.168.0.0-192.168.0.255".parse());

Implementations

impl Ipv4AddrRange

pub fn new(start: Ipv4Addr, end: Ipv4Addr) -> Ipv4AddrRange

Returns an Ipv4AddrRange.

pub fn start(self) -> Ipv4Addr

Returns the first ip.

pub fn end(self) -> Ipv4Addr

Returns the last ip.

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

Returns all ips included in the range.

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrRange;

let a = Ipv4Addr::new(0, 0, 0, 0);
let b = Ipv4Addr::new(0, 0, 0, 1);
let c = Ipv4Addr::new(0, 0, 0, 2);

assert_eq!(Ipv4AddrRange::new(a, c).all(), vec![a, b, c]);
assert_eq!(Ipv4AddrRange::new(c, a).all(), vec![c, b, a]);
assert_eq!(Ipv4AddrRange::new(a, a).all(), vec![a]);

pub fn size(&self) -> u32

Returns the number of ip’s included in the range.

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrRange;

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

let range = Ipv4AddrRange::new(a, b);
assert_eq!(range.size(), 11);

let range = Ipv4AddrRange::new(b, a);
assert_eq!(range.size(), 11);

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

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

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrRange;

let a = Ipv4Addr::new(192, 168, 0, 0);
let b = Ipv4Addr::new(192, 168, 0, 255);

let range = Ipv4AddrRange::new(a, b);

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

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

let range = Ipv4AddrRange::new(b, a);

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

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

Trait Implementations

impl Clone for Ipv4AddrRange

fn clone(&self) -> Ipv4AddrRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ipv4AddrRange

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

Formats the value using the given formatter.

impl Display for Ipv4AddrRange

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

Formats the value using the given formatter.

impl From<(Ipv4Addr, Ipv4Addr)> for Ipv4AddrRange

fn from(ips: (Ipv4Addr, Ipv4Addr)) -> Ipv4AddrRange

Create an Ipv4AddrRange from a tuple of two Ipv4Addr.

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrRange;

let start = Ipv4Addr::new(0, 0, 0, 0);
let end = Ipv4Addr::new(0, 0, 0, 10);

assert_eq!(Ipv4AddrRange::from((start, end)), Ipv4AddrRange::new(start, end));

impl From<Ipv4AddrRange> for IpAddrRange

fn from(range: Ipv4AddrRange) -> IpAddrRange

Create an IpAddrRange::V4 from an Ipv4AddrRange.

Examples:

use std::net::Ipv4Addr;

use net_adds::{IpAddrRange, Ipv4AddrRange};

let a = Ipv4Addr::new(0, 0, 0, 0);
let b = Ipv4Addr::new(0, 0, 0, 10);

assert_eq!(IpAddrRange::from(Ipv4AddrRange::new(a, b)), IpAddrRange::V4(Ipv4AddrRange::new(a, b)));

impl FromStr for Ipv4AddrRange

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

Parse a string as Ipv4AddrRange.

If the string representation is not valid return an NetAddsError::RangeAddrParse(RangeAddrParseError).

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrRange;

let range = Ipv4AddrRange::new(Ipv4Addr::new(192, 168, 0, 0), Ipv4Addr::new(192, 168, 0, 255));

assert_eq!("192.168.0.0-192.168.0.255".parse(), Ok(range));

type Err = NetAddsError

The associated error which can be returned from parsing.

impl Hash for Ipv4AddrRange

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 Ipv4AddrRange

fn into_iter(self) -> Self::IntoIter

Create a Ipv4Addr iterator.

Examples:

use std::net::Ipv4Addr;

use net_adds::Ipv4AddrRange;

let mut iter = Ipv4AddrRange::new(Ipv4Addr::new(0, 0, 0, 0), Ipv4Addr::new(0, 0, 0, 2)).into_iter();

assert_eq!(iter.next(), Some(Ipv4Addr::from(0)));
assert_eq!(iter.next(), Some(Ipv4Addr::from(1)));
assert_eq!(iter.next(), Some(Ipv4Addr::from(2)));
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 Ipv4AddrRange

fn into_smart_iter(self) -> Self::IntoSmartIter

Create a smart Ipv4Addr iterator.

Examples:

use std::net::Ipv4Addr;

use net_adds::{Ipv4AddrRange, IntoSmartIterator};

let mut iter = Ipv4AddrRange::new(Ipv4Addr::new(0, 0, 0, 0), Ipv4Addr::new(0, 0, 0, 2)).into_smart_iter();

assert_eq!(iter.next(), Some(Ipv4Addr::from(0)));
assert_eq!(iter.next(), Some(Ipv4Addr::from(1)));
assert_eq!(iter.next(), Some(Ipv4Addr::from(2)));
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 Ipv4AddrRange

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

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

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

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

This method tests for !=.

impl PartialOrd<Ipv4AddrRange> for Ipv4AddrRange

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

impl Eq for Ipv4AddrRange

impl StructuralEq for Ipv4AddrRange

impl StructuralPartialEq for Ipv4AddrRange