Struct rangemap::set::RangeSet

pub struct RangeSet<T> { /* private fields */ }

A set whose items are stored as (half-open) ranges bounded inclusively below and exclusively above (start..end).

See RangeMap’s documentation for more details.

Implementations

impl<T> RangeSet<T>

where T: Ord + Clone,

pub fn new() -> Self

Makes a new empty RangeSet.

pub fn get(&self, value: &T) -> Option<&Range<T>>

Returns a reference to the range covering the given key, if any.

pub fn contains(&self, value: &T) -> bool

Returns true if any range in the set covers the specified value.

pub fn iter(&self) -> Iter<'_, T>

Gets an ordered iterator over all ranges, ordered by range.

pub fn clear(&mut self)

Clears the set, removing all elements.

pub fn len(&self) -> usize

Returns the number of elements in the set.

pub fn is_empty(&self) -> bool

Returns true if the set contains no elements.

pub fn intersection<'a>(&'a self, other: &'a Self) -> Intersection<'a, T>

Return an iterator over the intersection of two range sets.

pub fn union<'a>(&'a self, other: &'a Self) -> Union<'a, T>

Return an iterator over the union of two range sets.

pub fn insert(&mut self, range: Range<T>)

Insert a range into the set.

If the inserted range either overlaps or is immediately adjacent any existing range, then the ranges will be coalesced into a single contiguous range.

Panics

Panics if range start >= end.

pub fn remove(&mut self, range: Range<T>)

Removes a range from the set, if all or any of it was present.

If the range to be removed partially overlaps any ranges in the set, then those ranges will be contracted to no longer cover the removed range.

Panics

Panics if range start >= end.

pub fn gaps<'a>(&'a self, outer_range: &'a Range<T>) -> Gaps<'a, T>

Gets an iterator over all the maximally-sized ranges contained in outer_range that are not covered by any range stored in the set.

If the start and end of the outer range are the same and it does not overlap any stored range, then a single empty gap will be returned.

The iterator element type is Range<T>.

pub fn overlapping<R: Borrow<Range<T>>>( &self, range: R ) -> Overlapping<'_, T, R>

Gets an iterator over all the stored ranges that are either partially or completely overlapped by the given range.

The iterator element type is &Range<T>.

pub fn overlaps(&self, range: &Range<T>) -> bool

Returns true if any range in the set completely or partially overlaps the given range.

pub fn first(&self) -> Option<&Range<T>>

Returns the first range in the set, if one exists. The range is the minimum range in this set.

pub fn last(&self) -> Option<&Range<T>>

Returns the last range in the set, if one exists. The range is the maximum range in this set.

Trait Implementations

impl<T: Ord + Clone> BitAnd for &RangeSet<T>

type Output = RangeSet<T>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T: Ord + Clone> BitOr for &RangeSet<T>

type Output = RangeSet<T>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T: Clone> Clone for RangeSet<T>

fn clone(&self) -> RangeSet<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for RangeSet<T>

where T: Ord + Clone + Debug,

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

Formats the value using the given formatter.

impl<T> Default for RangeSet<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Extend<Range<T>> for RangeSet<T>

where T: Ord + Clone,

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

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<T: Ord + Clone, const N: usize> From<[Range<T>; N]> for RangeSet<T>

fn from(value: [Range<T>; N]) -> Self

Converts to this type from the input type.

impl<T> FromIterator<Range<T>> for RangeSet<T>

where T: Ord + Clone,

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

Creates a value from an iterator.

impl<T: Hash> Hash for RangeSet<T>

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<T> IntoIterator for RangeSet<T>

type Item = Range<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for RangeSet<T>

fn cmp(&self, other: &RangeSet<T>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for RangeSet<T>

fn eq(&self, other: &RangeSet<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for RangeSet<T>

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for RangeSet<T>

impl<T> StructuralPartialEq for RangeSet<T>