Struct IpSet 

pub struct IpSet { /* private fields */ }

A collection of unique IP addresses stored as sorted, non-overlapping ranges.

Handles automatic merging of overlapping and adjacent ranges lazily.

Implementations

impl IpSet

pub fn new() -> Self

Creates a new, empty IpSet.

pub fn insert(&mut self, ip: IpAddr)

Adds a single IP address to the set.

This is a fast $O(1)$ operation that defers merging.

pub fn insert_range(&mut self, range: IpRange)

Adds a unified IP range to the set.

pub fn push_v4_range(&mut self, range: Ipv4Range)

Appends an IPv4 range without immediate merging.

pub fn push_v6_range(&mut self, range: Ipv6Range)

Appends an IPv6 range without immediate merging.

pub fn canonicalize(&mut self)

Manually triggers sorting and merging of all internal ranges.

Call this after bulk insertions to prepare the set for high-performance read-only queries or multithreaded scanning.

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

Checks if the set contains the given IP address. Performs lazy merging on a clone if needed.

pub fn len(&self) -> u128

Returns the total count of unique IP addresses. Performs lazy merging on a clone if needed.

pub fn is_empty(&self) -> bool

Returns true if the set is empty.

pub fn iter(&self) -> Box<dyn Iterator<Item = IpAddr> + Send + '_>

Returns an iterator over every individual IP address. Performs lazy merging on a clone if needed.

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

A high-performance, thread-safe version of contains.

Panics

Panics in debug mode if the set has pending unmerged ranges.

pub fn len_canonical(&self) -> u128

A thread-safe version of len.

Panics

Panics in debug mode if the set has pending unmerged ranges.

pub fn v4(&self) -> &[Ipv4Range]

Returns the underlying IPv4 ranges. If dirty, these ranges may be overlapping and un-merged.

pub fn v6(&self) -> &[Ipv6Range]

Returns the underlying IPv6 ranges. If dirty, these ranges may be overlapping and un-merged.

Trait Implementations

impl Clone for IpSet

fn clone(&self) -> IpSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IpSet

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

Formats the value using the given formatter.

impl Default for IpSet

fn default() -> IpSet

Returns the “default value” for a type.

impl Eq for IpSet

impl Extend<IpAddr> for IpSet

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

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<IpAddr> for IpSet

fn from(ip: IpAddr) -> Self

Converts to this type from the input type.

impl From<IpRange> for IpSet

fn from(range: IpRange) -> Self

Converts to this type from the input type.

impl FromIterator<IpAddr> for IpSet

fn from_iter<I: IntoIterator<Item = IpAddr>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<IpRange> for IpSet

fn from_iter<I: IntoIterator<Item = IpRange>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<IpSet> for IpSet

fn from_iter<I: IntoIterator<Item = IpSet>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for IpSet

type Err = IpSetError

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 IntoIterator for IpSet

fn into_iter(self) -> Self::IntoIter

Consumes the IpSet and returns an iterator over its individual IP addresses.

type Item = IpAddr

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = IpAddr> + Send>

Which kind of iterator are we turning this into?

impl PartialEq for IpSet

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IpSet

impl TryFrom<&str> for IpSet

type Error = IpSetError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.