Enum IpRange 

pub enum IpRange {
    V4 {
        start: Ipv4Addr,
        end: Ipv4Addr,
    },
    V6 {
        start: Ipv6Addr,
        end: Ipv6Addr,
    },
}

Inclusive IP range (start <= end) for either IPv4 or IPv6.

Keep this in your crate so you control ordering rules and serialization.

Variants

V4

Fields

start: Ipv4Addr

end: Ipv4Addr

V6

Fields

start: Ipv6Addr

end: Ipv6Addr

Implementations

impl IpRange

pub fn new(start: IpAddr, end: IpAddr) -> Result<Self, String>

Create a validated range.

Ensures the start/end address families match and that start <= end.

Examples

IPv4:

use std::net::{IpAddr, Ipv4Addr};
use firewall_objects::ip::range::IpRange;

let r = IpRange::new(
    IpAddr::V4(Ipv4Addr::new(192, 0, 2, 10)),
    IpAddr::V4(Ipv4Addr::new(192, 0, 2, 20)),
).unwrap();
assert!(r.contains(IpAddr::V4(Ipv4Addr::new(192, 0, 2, 15))));

IPv6:

use std::net::{IpAddr, Ipv6Addr};
use firewall_objects::ip::range::IpRange;

let r = IpRange::new(
    IpAddr::V6(Ipv6Addr::LOCALHOST),
    IpAddr::V6(Ipv6Addr::LOCALHOST),
).unwrap();
assert!(r.contains(IpAddr::V6(Ipv6Addr::LOCALHOST)));

Mismatched families fail:

use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use firewall_objects::ip::range::IpRange;

let err = IpRange::new(
    IpAddr::V4(Ipv4Addr::new(192, 0, 2, 10)),
    IpAddr::V6(Ipv6Addr::LOCALHOST),
).unwrap_err();
assert!(err.contains("families must match"));

pub fn new_v4(start: Ipv4Addr, end: Ipv4Addr) -> Result<Self, String>

Create a validated IPv4 range.

pub fn new_v6(start: Ipv6Addr, end: Ipv6Addr) -> Result<Self, String>

Create a validated IPv6 range.

pub fn family(&self) -> IpFamily

Return the IP family of this range.

pub fn as_v4(&self) -> Option<(Ipv4Addr, Ipv4Addr)>

Return the (start, end) tuple for an IPv4 range.

pub fn as_v6(&self) -> Option<(Ipv6Addr, Ipv6Addr)>

Return the (start, end) tuple for an IPv6 range.

pub fn start_v4(&self) -> Option<Ipv4Addr>

Return the start of the range as IPv4, if this is an IPv4 range.

pub fn end_v4(&self) -> Option<Ipv4Addr>

Return the end of the range as IPv4, if this is an IPv4 range.

pub fn start_v6(&self) -> Option<Ipv6Addr>

Return the start of the range as IPv6, if this is an IPv6 range.

pub fn end_v6(&self) -> Option<Ipv6Addr>

Return the end of the range as IPv6, if this is an IPv6 range.

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

Check whether the given IPv4 address is within the range (inclusive).

pub fn contains_v6(&self, ip: Ipv6Addr) -> bool

Check whether the given IPv6 address is within the range (inclusive).

pub fn parse(s: &str) -> Result<Self, String>

Parse an IP range from a string.

Supported format is start-end where both sides are valid IP addresses of the same family (IPv4 or IPv6). Whitespace around addresses is allowed.

Examples

IPv4:

use std::net::{IpAddr, Ipv4Addr};
use firewall_objects::ip::range::IpRange;

let r = IpRange::parse("192.0.2.10-192.0.2.20").unwrap();
assert!(r.contains(IpAddr::V4(Ipv4Addr::new(192, 0, 2, 15))));

IPv6:

use std::net::{IpAddr, Ipv6Addr};
use firewall_objects::ip::range::IpRange;

let r = IpRange::parse("::1-::1").unwrap();
assert!(r.contains(IpAddr::V6(Ipv6Addr::LOCALHOST)));

Bad formats fail:

use firewall_objects::ip::range::IpRange;

assert!(IpRange::parse("192.0.2.10").is_err());
assert!(IpRange::parse("192.0.2.10-").is_err());
assert!(IpRange::parse("-192.0.2.10").is_err());

pub fn start(&self) -> IpAddr

Return the start of the range.

pub fn end(&self) -> IpAddr

Return the end of the range.

pub fn is_v4(&self) -> bool

Returns true if this is an IPv4 range.

pub fn is_v6(&self) -> bool

Returns true if this is an IPv6 range.

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

Check whether the given IP is within the range (inclusive).

Trait Implementations

impl Clone for IpRange

fn clone(&self) -> IpRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IpRange

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

Formats the value using the given formatter.

impl Display for IpRange

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

Formats the value using the given formatter.

impl FromStr for IpRange

type Err = String

The associated error which can be returned from parsing.

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

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

impl Hash for IpRange

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 IpRange

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

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

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

impl Eq for IpRange

impl StructuralPartialEq for IpRange