Skip to main content

DenseRangeMap

Struct DenseRangeMap 

Source
pub(crate) struct DenseRangeMap<K, V1, V2>
where K: Clone + 'static, V1: Clone + 'static, V2: Clone + 'static,
{ starts: Cow<'static, [K]>, values1: Cow<'static, [Option<V1>]>, values2: Option<Cow<'static, [Option<V2>]>>, }
Expand description

An immutable map from ranges to Option<V1>, Option<V2>-pairs.

This type is optimized for reasonable O(lg N) performance, and for space efficiency in the case where:

  • Option<V> is the same size as V, or at least not much larger.
  • most or all ranges have no gaps between them.
  • we might not want to record any values for V2 at all.
  • we are willing to treat “no entry” and “maps to None” as equivalent.

That is to say, we get our space efficiency wins in the case where, if some range (K..=V) in the map, (V+1..=K2) is also likely to be in the map.

(This is true for around like 99% of our IPv4 ranges and around 91% of our IPv6 ranges.)

This type is crate-internal because its functionality is limited, and because we may want to switch to some other approach to geoip in the future.

§Overview

We consider a map of disjoint ranges (S..=E) => V as a dense map from (S'..=E') => Option<V1, V2>, such that there is is exactly one (S'..E') range covering every value from min(S) through K::MAX inclusive.

Because this map is dense, we can encode these ranges as a sorted list of S’, and then use a binary search to find which Option<V1, V2> corresponds to any given value.

§Invariants

  • starts is sorted and contains no duplicates.
  • values1.len() == starts.len()
  • If values2 is present, values2.len() == starts.len()

§Semantics:

This table maps keys to value as follows:

If starts is empty, then every key maps to None.

Otherwise:

  • Every key such that K::min <= key < starts[0] maps to None.
  • Every key such that starts[idx] <= key < starts[idx+1] maps to values[idx], which may be Some or None.
  • Every key such that key >= starts.last() maps to values.last(), which may be Some or None.

If values2 is present, then keys map to the same indices in values2 as they do in values1.

Fields§

§starts: Cow<'static, [K]>

A list of the starting points of each range or gap.

§values1: Cow<'static, [Option<V1>]>

A list of values.

If starts[i] is the start of a range, then values[i] is Some(v) where v is the value of that range for every

§values2: Option<Cow<'static, [Option<V2>]>>

An optional list of secondary values.

Implementations§

Source§

impl<K, V1, V2> DenseRangeMap<K, V1, V2>
where K: Clone + 'static + Eq + Ord + Successor, V1: Clone + 'static, V2: Clone + 'static,

Source

pub(crate) fn from_static_parts( starts: &'static [K], values1: &'static [Option<V1>], values2: Option<&'static [Option<V2>]>, ) -> Self

Create a new map from its raw parts.

Requires that the slices are actually the results of calling export() on a map of this type.

Source

pub(crate) fn try_from_sorted_inclusive_ranges<S, E>( iter: S, discard_v2: bool, ) -> Result<Self, E>
where S: Iterator<Item = Result<(RangeInclusive<K>, Option<V1>, Option<V2>), E>>, E: From<Error>,

Construct a DenseRangeMap from an iterator of Result<(range,optvalue1,optvalue2)> tuples.

The ranges must be disjoint and sorted in ascending order by their start.

Source

pub(crate) fn index_for_key(&self, key: &K) -> Option<usize>

Return the index for the values corresponding to key.

Source

pub(crate) fn get1(&self, key: &K) -> Option<&V1>

Return the value, if any, associated with the given key.

Source

pub(crate) fn get2(&self, key: &K) -> Option<&V2>

Return the secondary value, if any, associated with the given key.

Source

pub(crate) fn export(&self) -> (&[K], &[Option<V1>], Option<&[Option<V2>]>)

Return a triple of slices that encode this map.

Trait Implementations§

Source§

impl<K, V1, V2> Clone for DenseRangeMap<K, V1, V2>
where K: Clone + 'static + Clone, V1: Clone + 'static + Clone, V2: Clone + 'static + Clone,

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K, V1, V2> Debug for DenseRangeMap<K, V1, V2>
where K: Clone + 'static + Debug, V1: Clone + 'static + Debug, V2: Clone + 'static + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<K, V1, V2> Default for DenseRangeMap<K, V1, V2>
where K: Clone + 'static, V1: Clone + 'static, V2: Clone + 'static,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<K, V1, V2> Eq for DenseRangeMap<K, V1, V2>
where K: Clone + 'static + Eq, V1: Clone + 'static + Eq, V2: Clone + 'static + Eq,

Source§

impl<K, V1, V2> PartialEq for DenseRangeMap<K, V1, V2>
where K: Clone + 'static + PartialEq, V1: Clone + 'static + PartialEq, V2: Clone + 'static + PartialEq,

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<K, V1, V2> StructuralPartialEq for DenseRangeMap<K, V1, V2>
where K: Clone + 'static + PartialEq, V1: Clone + 'static + PartialEq, V2: Clone + 'static + PartialEq,

Auto Trait Implementations§

§

impl<K, V1, V2> Forget for DenseRangeMap<K, V1, V2>

§

impl<K, V1, V2> Freeze for DenseRangeMap<K, V1, V2>
where Cow<'static, [K]>: Freeze, Cow<'static, [Option<V1>]>: Freeze, Option<Cow<'static, [Option<V2>]>>: Freeze,

§

impl<K, V1, V2> Move for DenseRangeMap<K, V1, V2>

§

impl<K, V1, V2> RefUnwindSafe for DenseRangeMap<K, V1, V2>
where Cow<'static, [K]>: RefUnwindSafe, Cow<'static, [Option<V1>]>: RefUnwindSafe, Option<Cow<'static, [Option<V2>]>>: RefUnwindSafe,

§

impl<K, V1, V2> Send for DenseRangeMap<K, V1, V2>
where Cow<'static, [K]>: Send, Cow<'static, [Option<V1>]>: Send, Option<Cow<'static, [Option<V2>]>>: Send,

§

impl<K, V1, V2> Sync for DenseRangeMap<K, V1, V2>
where Cow<'static, [K]>: Sync, Cow<'static, [Option<V1>]>: Sync, Option<Cow<'static, [Option<V2>]>>: Sync,

§

impl<K, V1, V2> Unpin for DenseRangeMap<K, V1, V2>
where Cow<'static, [K]>: Unpin, Cow<'static, [Option<V1>]>: Unpin, Option<Cow<'static, [Option<V2>]>>: Unpin,

§

impl<K, V1, V2> UnsafeUnpin for DenseRangeMap<K, V1, V2>
where Cow<'static, [K]>: UnsafeUnpin, Cow<'static, [Option<V1>]>: UnsafeUnpin, Option<Cow<'static, [Option<V2>]>>: UnsafeUnpin,

§

impl<K, V1, V2> UnwindSafe for DenseRangeMap<K, V1, V2>
where Cow<'static, [K]>: UnwindSafe, Cow<'static, [Option<V1>]>: UnwindSafe, Option<Cow<'static, [Option<V2>]>>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more