Struct rangemap::RangeInclusiveMap

pub struct RangeInclusiveMap<K, V, StepFnsT = K> { /* fields omitted */ }

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

Contiguous and overlapping ranges that map to the same value are coalesced into a single range.

Successor and predecessor functions must be provided for the key type K, so that we can detect adjacent but non-overlapping (closed) ranges. (This is not a problem for half-open ranges, because adjacent ranges can be detected using equality of range ends alone.)

You can provide these functions either by implementing the StepLite trait for your key type K, or, if this is impossible because of Rust’s “orphan rules”, you can provide equivalent free functions using the StepFnsT type parameter. StepLite is implemented for all standard integer types, but not for any third party crate types.

Implementations

impl<K, V> RangeInclusiveMap<K, V, K> where
    K: Ord + Clone + StepLite,
    V: Eq + Clone, 

pub fn new() -> Self

Makes a new empty RangeInclusiveMap.

impl<K, V, StepFnsT> RangeInclusiveMap<K, V, StepFnsT> where
    K: Ord + Clone,
    V: Eq + Clone,
    StepFnsT: StepFns<K>, 

pub fn new_with_step_fns() -> Self

Makes a new empty RangeInclusiveMap, specifying successor and predecessor functions defined separately from K itself.

This is useful as a workaround for Rust’s “orphan rules”, which prevent you from implementing StepLite for K if K 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, key: &K) -> Option<&V>

Returns a reference to the value corresponding to the given key, if the key is covered by any range in the map.

pub fn get_key_value(&self, key: &K) -> Option<(&RangeInclusive<K>, &V)>

Returns the range-value pair (as a pair of references) corresponding to the given key, if the key is covered by any range in the map.

pub fn contains_key(&self, key: &K) -> bool

Returns true if any range in the map covers the specified key.

pub fn iter(&self) -> impl Iterator<Item = (&RangeInclusive<K>, &V)>

Gets an iterator over all pairs of key range and value, ordered by key range.

The iterator element type is (&'a RangeInclusive<K>, &'a V).

pub fn insert(&mut self, range: RangeInclusive<K>, value: V)

Insert a pair of key range and value into the map.

If the inserted range partially or completely overlaps any existing range in the map, then the existing range (or ranges) will be partially or completely replaced by the inserted range.

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

Panics

Panics if range start > end.

pub fn remove(&mut self, range: RangeInclusive<K>)

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

If the range to be removed partially overlaps any ranges in the map, 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<K>
) -> Gaps<'a, K, V, StepFnsT>

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

The iterator element type is RangeInclusive<K>.

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

Trait Implementations

impl<K: Clone, V: Clone, StepFnsT: Clone> Clone for RangeInclusiveMap<K, V, StepFnsT>

fn clone(&self) -> RangeInclusiveMap<K, V, StepFnsT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for RangeInclusiveMap<K, V> where
    K: Ord + Clone + StepLite,
    V: Eq + Clone, 

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

Formats the value using the given formatter.

impl<K, V> Default for RangeInclusiveMap<K, V, K> where
    K: Ord + Clone + StepLite,
    V: Eq + Clone, 

fn default() -> Self

Returns the “default value” for a type.

impl<K, V> Extend<(RangeInclusive<K>, V)> for RangeInclusiveMap<K, V> where
    K: Ord + Clone + StepLite,
    V: Eq + Clone, 

fn extend<T: IntoIterator<Item = (RangeInclusive<K>, V)>>(&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<K, V> FromIterator<(RangeInclusive<K>, V)> for RangeInclusiveMap<K, V> where
    K: Ord + Clone + StepLite,
    V: Eq + Clone, 

fn from_iter<T: IntoIterator<Item = (RangeInclusive<K>, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl<K, V> IntoIterator for RangeInclusiveMap<K, V>

type Item = (RangeInclusive<K>, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.