Struct RangeMap

pub struct RangeMap<K: Ord + Copy + Gap, V: Clone + Eq> { /* private fields */ }

A map from ranges to values.

This map can be cloned efficiently. If the map is modified after being cloned, the relevant parts of the map’s internal structure will be copied lazily.

Implementations

impl<K, V> RangeMap<K, V>

where K: Ord + Copy + Gap, V: Clone + Eq,

pub fn is_empty(&self) -> bool

Whether this map contains any entries.

pub fn get(&self, key: K) -> Option<(&Range<K>, &V)>

Searches the map for a range that contains the given key.

Returns the range and value if such a range is found.

pub fn last_range(&self) -> Option<&Range<K>>

The last range stored in this map.

pub fn find_gap_end(&self, gap: u64, upper_bound: &K) -> K

Find a gap that is at least as large as the given gap and is less than the given upper bound.

Returns the end of the gap, which might above or below the entries in the map.

pub fn remove(&mut self, range: Range<K>) -> Vec<V>

Remove the entry with the given key from the map.

If the key was present in the map, returns the value previously stored at the given key.

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

Inserts a range with the given value.

The keys included in the given range are now associated with the given value. If those keys were previously associated with another value, are no longer associated with that previous value.

This method can cause one or more values in the map to be dropped if the all of the keys associated with those values are contained within the given range.

If the inserted range is directly adjacent to another range with an equal value, the inserted range will be merged with the adjacent ranges.

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

Iterate through the keys and values stored in the map.

pub fn range(&self, bounds: impl RangeBounds<K>) -> Iter<'_, K, V>

Iterate through the keys and values stored in the given range in the map.

pub fn find_at_or_after(&self, key: K) -> Option<(&Range<K>, &V)>

Find the first range in the map that starts at or after the given key.

Trait Implementations

impl<K: Clone + Ord + Copy + Gap, V: Clone + Clone + Eq> Clone for RangeMap<K, V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Ord + Copy + Gap, V: Debug + Clone + Eq> Debug for RangeMap<K, V>

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

Formats the value using the given formatter.

impl<K, V> Default for RangeMap<K, V>

where K: Ord + Copy + Gap, V: Clone + Eq,

fn default() -> Self

Returns the “default value” for a type.