Struct rangemap::RangeInclusiveSet

pub struct RangeInclusiveSet<T, StepFnsT = T> { /* fields omitted */ }

A set whose items are stored as ranges bounded inclusively below and above (start..=end).

See RangeInclusiveMap’s documentation for more details.

Implementations

impl<T> RangeInclusiveSet<T, T> where
    T: Ord + Clone + StepLite, 

pub fn new() -> Self

Makes a new empty RangeInclusiveSet.

impl<T, StepFnsT> RangeInclusiveSet<T, StepFnsT> where
    T: Ord + Clone,
    StepFnsT: StepFns<T>, 

pub fn new_with_step_fns() -> Self

Makes a new empty RangeInclusiveSet, specifying successor and predecessor functions defined separately from T itself.

This is useful as a workaround for Rust’s “orphan rules”, which prevent you from implementing StepLite for T if T is a foreign type.

NOTE: This will likely be deprecated and then eventually removed once the standard library’s Step trait is stabilised, as most crates will then likely implement Step for their types where appropriate.

See this issue for details about that stabilization process.

pub fn get(&self, value: &T) -> Option<&RangeInclusive<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) -> impl Iterator<Item = &RangeInclusive<T>>

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

pub fn insert(&mut self, range: RangeInclusive<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: RangeInclusive<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 RangeInclusive<T>
) -> Gaps<'a, T, StepFnsT>

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

The iterator element type is RangeInclusive<T>.

NOTE: Calling gaps eagerly finds the first gap, even if the iterator is never consumed.

Trait Implementations

impl<T: Clone, StepFnsT: Clone> Clone for RangeInclusiveSet<T, StepFnsT>

fn clone(&self) -> RangeInclusiveSet<T, StepFnsT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for RangeInclusiveSet<T> where
    T: Ord + Clone + StepLite, 

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

Formats the value using the given formatter.

impl<T> Default for RangeInclusiveSet<T, T> where
    T: Ord + Clone + StepLite, 

fn default() -> Self

Returns the “default value” for a type.

impl<T> Extend<RangeInclusive<T>> for RangeInclusiveSet<T> where
    T: Ord + Clone + StepLite, 

fn extend<I: IntoIterator<Item = RangeInclusive<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> FromIterator<RangeInclusive<T>> for RangeInclusiveSet<T> where
    T: Ord + Clone + StepLite, 

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

Creates a value from an iterator.

impl<T> IntoIterator for RangeInclusiveSet<T>

type Item = RangeInclusive<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.