Struct mpchash::KeyRange

pub struct KeyRange<Idx>
where
    Idx: Bounded,
{
    pub start: Idx,
    pub end: Idx,
}

A (half-open) range bounded inclusively below and exclusively above i.e. [start..end).

If start >= end, the range is considered wrapping and is equivalent to covering union of two ranges: [start..MAX_VALUE] and [0..end).

Fields

start: Idx

end: Idx

Implementations

impl<Idx: Bounded> KeyRange<Idx>

pub fn new(start: Idx, end: Idx) -> Self

Creates a new range.

impl<Idx> KeyRange<Idx>

where Idx: PartialOrd<Idx> + Clone + Debug + Bounded + Ord,

pub fn is_wrapping(&self) -> bool

Returns true if the range is wrapping, which is equivalent to union of the following two ranges: [start..MAX_VALUE] and [0..end)..

pub fn is_inverted(&self) -> bool

Returns true if the range is inverted, i.e. start >= end.

pub fn ends_at_origin(&self) -> bool

Returns true if the range ends at the origin.

This is useful for distinguishing a special case of non-wrapping range that has inverted positions, end < start, but is still non-wrapping.

pub fn covers_whole_ring(&self) -> bool

Returns true if the range covers the whole ring.

pub fn contains(&self, item: &Idx) -> bool

Returns true if item is contained in the range.

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

Returns true if the range overlaps with other.

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

Returns true if one range is a continuation of the other.

That’s intervals do not intersect, but can be merged i.e. for a given intervals [a, b) and [b, c) the union is [a, c).

pub fn merged(&self, other: &Self) -> Option<Self>

Returns a new range that is the union of self and other if they can be merged into a single interval. For ranges that can’t be merged, returns None.

impl KeyRange<RingPosition>

pub fn size(&self) -> RingPosition

Trait Implementations

impl<Idx> Clone for KeyRange<Idx>

where Idx: Bounded + Clone,

fn clone(&self) -> KeyRange<Idx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Idx> Debug for KeyRange<Idx>

where Idx: Bounded + Debug,

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

Formats the value using the given formatter.

impl<Idx> Hash for KeyRange<Idx>

where Idx: Bounded + Hash,

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<Idx> PartialEq for KeyRange<Idx>

where Idx: Bounded + PartialEq,

fn eq(&self, other: &KeyRange<Idx>) -> 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<Idx> Eq for KeyRange<Idx>

where Idx: Bounded + Eq,

impl<Idx> StructuralEq for KeyRange<Idx>

where Idx: Bounded,

impl<Idx> StructuralPartialEq for KeyRange<Idx>

where Idx: Bounded,