Struct PrefixSet

pub struct PrefixSet { /* private fields */ }

Available on crate feature std only.

A collection of mixed IPv4 and IPv6 prefixes.

See also traits::PrefixSet and concrete::PrefixSet.

Examples

let set: PrefixSet<Any> = ["192.0.2.0/24,25,26", "2001:db8::/48,52,52"]
    .into_iter()
    .map(PrefixRange::<Any>::from_str)
    .collect::<Result<_, _>>()?;
assert_eq!(set.len(), 6 + 16);

Implementations

impl Set

pub fn partition(self) -> (PrefixSet<Ipv4>, PrefixSet<Ipv6>)

Partition the prefix set by address family.

Examples

let set: PrefixSet<Any> = ["192.0.2.0/24", "2001:db8::/32"]
    .into_iter()
    .map(Prefix::<Any>::from_str)
    .collect::<Result<_, _>>()?;
let (_, ipv6) = set.partition();
let mut ipv6_prefixes = ipv6.prefixes();
assert_eq!(
    ipv6_prefixes.next().map(|p| p.to_string()),
    Some("2001:db8::/32".to_string())
);
assert_eq!(ipv6_prefixes.next(), None);

pub const fn as_partitions(&self) -> (&PrefixSet<Ipv4>, &PrefixSet<Ipv6>)

Borrow the address-family partitions of the prefix set.

Examples

let set: PrefixSet<Any> = ["192.0.2.0/24", "2001:db8::/32"]
    .into_iter()
    .map(Prefix::<Any>::from_str)
    .collect::<Result<_, _>>()?;
let (ipv4, _) = set.as_partitions();
let mut ipv4_prefixes = ipv4.prefixes();
assert_eq!(
    ipv4_prefixes.next().map(|p| p.to_string()),
    Some("192.0.2.0/24".to_string())
);
assert_eq!(ipv4_prefixes.next(), None);

pub fn as_mut_partitions( &mut self, ) -> (&mut PrefixSet<Ipv4>, &mut PrefixSet<Ipv6>)

Mutably borrow the address-family partitions of the prefix set.

Examples

let mut set: PrefixSet<Any> = ["192.0.2.0/24", "2001:db8::/32"]
    .into_iter()
    .map(Prefix::<Any>::from_str)
    .collect::<Result<_, _>>()?;

let (ipv4, _) = set.as_mut_partitions();
let new = "192.0.2.128/25".parse::<Prefix<Ipv4>>()?;
_ = ipv4.insert(new);

assert_eq!(set.len(), 3);

Trait Implementations

impl Add for Set

type Output = Set

The resulting type after applying the + operator.

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

Performs the + operation.

impl BitAnd for Set

type Output = Set

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr for Set

type Output = Set

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitXor for Set

type Output = Set

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl Clone for Set

fn clone(&self) -> Set

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Set

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

Formats the value using the given formatter.

impl Default for Set

fn default() -> Set

Returns the “default value” for a type.

impl Extend<Prefix> for Set

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

where I: IntoIterator<Item = Prefix>,

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 Extend<Range> for Set

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

where I: IntoIterator<Item = Range>,

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<T> FromIterator<T> for Set

where Self: Extend<T>,

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

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl Mul for Set

type Output = Set

The resulting type after applying the * operator.

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

Performs the * operation.

impl Not for Set

type Output = Set

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl One for Set

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 PartialEq for Set

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

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> Set<'a> for Set

type Prefix = Prefix

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

type Range = Range

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

type Prefixes = Prefixes<'a>

The iterator returned by Self::prefixes.

type Ranges = Ranges<'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 Sub for Set

type Output = Set

The resulting type after applying the - operator.

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

Performs the - operation.

impl Zero for Set

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 Eq for Set

impl StructuralPartialEq for Set