Struct PrefixSet

Source
pub struct PrefixSet<A: Afi> { /* private fields */ }
Available on crate feature std only.
Expand description

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§

Source§

impl<A: Afi> Set<A>

Source

pub const fn new() -> Self

Construct a new, empty PrefixSet<A>.

Source

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);
Source

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);
Source

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);
Source

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);
Source

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§

Source§

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

Source§

type Output = Set<A>

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

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

Source§

type Output = Set<A>

The resulting type after applying the & operator.
Source§

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

Performs the & operation. Read more
Source§

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

Source§

type Output = Set<A>

The resulting type after applying the | operator.
Source§

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

Performs the | operation. Read more
Source§

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

Source§

type Output = Set<A>

The resulting type after applying the ^ operator.
Source§

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

Performs the ^ operation. Read more
Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<A: Afi, U> Extend<U> for Set<A>
where U: Into<Node<A>>,

Source§

fn extend<T>(&mut self, iter: T)
where T: IntoIterator<Item = U>,

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

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. Read more
Source§

impl From<Set<Ipv4>> for Set

Source§

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

Converts to this type from the input type.
Source§

impl From<Set<Ipv6>> for Set

Source§

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

Converts to this type from the input type.
Source§

impl<A: Afi, T> FromIterator<T> for Set<A>
where T: Into<Node<A>>,

Source§

fn from_iter<I>(iter: I) -> Self
where I: IntoIterator<Item = T>,

Creates a value from an iterator. Read more
Source§

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

Source§

type Output = Set<A>

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

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

Source§

type Output = Set<A>

The resulting type after applying the ! operator.
Source§

fn not(self) -> Self::Output

Performs the unary ! operation. Read more
Source§

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

Source§

fn one() -> Self

Returns the multiplicative identity element of Self, 1. Read more
Source§

fn set_one(&mut self)

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

fn is_one(&self) -> bool
where Self: PartialEq,

Returns true if self is equal to the multiplicative identity. Read more
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<'a, A: Afi> Set<'a> for Set<A>

Source§

type Prefix = Prefix<A>

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

type Range = Range<A>

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

type Prefixes = Prefixes<'a, A>

The iterator returned by Self::prefixes.
Source§

type Ranges = Ranges<'a, A>

The iterator returned by Self::ranges.
Source§

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

Get an iterator over the Self::Prefixs contained in self. Read more
Source§

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

Get an iterator over the Self::Ranges contained in self. Read more
Source§

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

Test whether prefix is contained in self. Read more
Source§

fn any() -> Self

Construct a prefix-set consisting of all prefixes. Read more
Source§

fn len(&'a self) -> usize

Get the number of prefixes in self. Read more
Source§

fn is_empty(&'a self) -> bool

Test whether self is empty. Read more
Source§

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

Source§

type Output = Set<A>

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

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

Source§

fn zero() -> Self

Returns the additive identity element of Self, 0. Read more
Source§

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.
Source§

fn set_zero(&mut self)

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

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

Auto Trait Implementations§

§

impl<A> Freeze for Set<A>

§

impl<A> RefUnwindSafe for Set<A>

§

impl<A> Send for Set<A>
where <<A as Afi>::Primitive as Address<A>>::LengthMap: Send, <A as Afi>::Primitive: Send, <<A as Afi>::Primitive as Address<A>>::Length: Send,

§

impl<A> Sync for Set<A>
where <<A as Afi>::Primitive as Address<A>>::LengthMap: Sync, <A as Afi>::Primitive: Sync, <<A as Afi>::Primitive as Address<A>>::Length: Sync,

§

impl<A> Unpin for Set<A>

§

impl<A> UnwindSafe for Set<A>
where <<A as Afi>::Primitive as Address<A>>::LengthMap: UnwindSafe, <A as Afi>::Primitive: UnwindSafe, <<A as Afi>::Primitive as Address<A>>::Length: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V