Struct PrefixSet

pub struct PrefixSet<A: Afi> { /* private fields */ }

Available on crate feature std only.

A collection of IP prefixes, providing fast insertion and iteration, and set-theorectic arithmetic.

This is a Rust implementation derived in large part from the internal data-structure used in the widely used bgpq3 tool by Alexandre Snarskii, packaged as a library, and with set-theoretic operations added.

Examples

use ip::{traits::PrefixSet as _, Error, Ipv6, Prefix, PrefixLength, PrefixRange, PrefixSet};

fn main() -> Result<(), Error> {
    // create a set by parsing a Vec<&str>
    let set: PrefixSet<Ipv6> = ["2001:db8::/37", "2001:db8:f00::/37"]
        .into_iter()
        .map(|s| s.parse::<Prefix<Ipv6>>())
        .collect::<Result<_, _>>()?;

    // create a range by parsing a &str and providing the lower
    // and upper prefix lenth bounds
    let length = PrefixLength::<Ipv6>::from_primitive(37)?;
    let range = PrefixRange::<Ipv6>::new("2001:db8::/36".parse()?, length..=length)?;

    assert_eq!(set.ranges().collect::<Vec<_>>(), vec![range]);
    Ok(())
}

Most mutating methods return &mut Self for easy chaining, e.g.:

let set = PrefixSet::<Ipv4>::new()
    .insert("192.0.2.0/24".parse::<Prefix<Ipv4>>()?)
    .to_owned();
assert_eq!(set.len(), 1);

Implementations

impl<A: Afi> Set<A>

pub const fn new() -> Self

Construct a new, empty PrefixSet<A>.

pub fn insert<T>(&mut self, item: T) -> &mut Self

where T: Into<Node<A>>,

Insert a new item into self.

T can be either a Prefix<A> or a PrefixRange<A>.

let range: PrefixRange<Ipv6> = "2001:db8:f00::/48,64,64".parse()?;
let set = PrefixSet::<Ipv6>::new().insert(range).to_owned();
assert_eq!(set.len(), 1 << 16);

pub fn insert_from<I, T>(&mut self, iter: I) -> &mut Self

where I: IntoIterator<Item = T>, T: Into<Node<A>>,

Insert items into self from an iterator yielding either Prefix<A> or PrefixRange<A>.

Aggregation occurs after all items are inserted, making this far more efficient than calling PrefixSet::insert() repeatedly.

let prefixes: Vec<_> = ["192.0.2.0/26", "192.0.2.64/26"]
    .into_iter()
    .map(|s| s.parse::<Prefix<Ipv4>>())
    .collect::<Result<_, _>>()?;
let set = PrefixSet::<Ipv4>::new().insert_from(prefixes).to_owned();
assert_eq!(set.len(), 2);

pub fn remove<T>(&mut self, item: T) -> &mut Self

where T: Into<Node<A>>,

Remove an item from self.

T can be either a Prefix<A> or a PrefixRange<A>.

let set = ["2001:db8:f00::/48", "2001:db8:baa::/48"]
    .into_iter()
    .map(|s| s.parse::<Prefix<Ipv6>>())
    .collect::<Result<PrefixSet<Ipv6>, _>>()?
    .remove("2001:db8:f00::/48".parse::<Prefix<Ipv6>>()?)
    .to_owned();
assert_eq!(set.len(), 1);

pub fn remove_from<I, T>(&mut self, iter: I) -> &mut Self

where I: IntoIterator<Item = T>, T: Into<Node<A>>,

Remove items from self from an iterator yielding either Prefix<A> or PrefixRange<A>.

Aggregation occurs after all items are removed, making this far more efficient than calling PrefixSet::remove() repeatedly.

let prefixes: Vec<_> = vec!["192.0.2.0/26", "192.0.2.64/26"]
    .into_iter()
    .map(|s| s.parse::<Prefix<Ipv4>>())
    .collect::<Result<_, _>>()?;
let mut set = PrefixSet::<Ipv4>::new()
    .insert("192.0.2.0/24,26,26".parse::<PrefixRange<Ipv4>>()?)
    .to_owned();
assert_eq!(set.remove_from(prefixes).len(), 2);

pub fn clear(&mut self)

Clear the contents of self

let mut set = PrefixSet::<Ipv6>::new()
    .insert("2001:db8::/32".parse::<Prefix<Ipv6>>()?)
    .to_owned();
assert!(!set.is_empty());
set.clear();
assert!(set.is_empty());

Trait Implementations

impl<A: Afi> Add for Set<A>

type Output = Set<A>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<A: Afi> BitAnd for Set<A>

type Output = Set<A>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl<A: Afi> BitOr for Set<A>

type Output = Set<A>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<A: Afi> BitXor for Set<A>

type Output = Set<A>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl<A: Clone + Afi> Clone for Set<A>

fn clone(&self) -> Set<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug + Afi> Debug for Set<A>

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

Formats the value using the given formatter.

impl<A: Afi> Default for Set<A>

fn default() -> Self

Returns the “default value” for a type.

impl<A: Afi, U> Extend<U> for Set<A>

where U: Into<Node<A>>,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = U>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl From<Set<Ipv4>> for Set

fn from(value: PrefixSet<Ipv4>) -> Self

Converts to this type from the input type.

impl From<Set<Ipv6>> for Set

fn from(value: PrefixSet<Ipv6>) -> Self

Converts to this type from the input type.

impl<A: Afi, T> FromIterator<T> for Set<A>

where T: Into<Node<A>>,

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<A: Afi> Mul for Set<A>

type Output = Set<A>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<A: Afi> Not for Set<A>

type Output = Set<A>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<A: Afi> One for Set<A>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl<A: Afi> PartialEq for Set<A>

fn eq(&self, other: &Self) -> 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<A: Afi> PartialOrd for Set<A>

fn partial_cmp(&self, other: &Self) -> 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<'a, A: Afi> Set<'a> for Set<A>

type Prefix = Prefix<A>

The type of IP prefix over which Self represents a set.

type Range = Range<A>

The type of IP prefix-range over which Self represents a set.

type Prefixes = Prefixes<'a, A>

The iterator returned by Self::prefixes.

type Ranges = Ranges<'a, A>

The iterator returned by Self::ranges.

fn prefixes(&'a self) -> Self::Prefixes

Get an iterator over the Self::Prefixs contained in self.

fn ranges(&'a self) -> Self::Ranges

Get an iterator over the Self::Ranges contained in self.

fn contains(&self, prefix: Self::Prefix) -> bool

Test whether prefix is contained in self.

fn any() -> Self

Construct a prefix-set consisting of all prefixes.

fn len(&'a self) -> usize

Get the number of prefixes in self.

fn is_empty(&'a self) -> bool

Test whether self is empty.

impl<A: Afi> Sub for Set<A>

type Output = Set<A>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<A: Afi> Zero for Set<A>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<A: Afi> Eq for Set<A>