Struct range_collections::range_set::RangeSetRef

#[repr(transparent)]
pub struct RangeSetRef<T>(_);

A reference to a range set

Implementations

impl<T> RangeSetRef<T>

pub fn single(value: &T) -> &Self

Create a new range set reference for a single value

pub fn new(boundaries: &[T]) -> Option<&Self>where T: Ord,

Create a new range set reference

This performs a check that the boundaries are strictly sorted. If you want to avoid this check, use new_unchecked (behind a feature flag because it is unsafe)

pub fn split(&self, at: T) -> (&Self, &Self)where T: Ord,

Split this range set into two parts left, right at position at, so that left is identical to self for all x < at and right is identical to self for all x >= at.

More precisely: contains(left, x) == contains(ranges, x) for x < at contains(right, x) == contains(ranges, x) for x >= at

This is not the same as limiting the ranges to the left or right of at, but it is much faster. It requires just a binary search and no allocations.

pub fn boundaries(&self) -> &[T]

The boundaries of the range set, guaranteed to be strictly sorted

pub fn contains(&self, value: &T) -> boolwhere T: Ord,

true if the value is contained in the range set

pub fn is_empty(&self) -> bool

true if the range set is empty

pub fn is_all(&self) -> boolwhere T: RangeSetEntry,

true if the range set contains all values

pub fn intersects(&self, that: &RangeSetRef<T>) -> boolwhere T: Ord,

true if this range set intersects from another range set

This is just the opposite of is_disjoint, but is provided for better discoverability.

pub fn is_disjoint(&self, that: &RangeSetRef<T>) -> boolwhere T: Ord,

true if this range set is disjoint from another range set

pub fn is_subset(&self, that: &RangeSetRef<T>) -> boolwhere T: Ord,

true if this range set is a superset of another range set

A range set is considered to be a superset of itself

pub fn is_superset(&self, that: &RangeSetRef<T>) -> boolwhere T: Ord,

true if this range set is a subset of another range set

A range set is considered to be a subset of itself

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

iterate over all ranges in this range set

pub fn intersection<A>(&self, that: &RangeSetRef<T>) -> RangeSet<A>where A: Array<Item = T>, T: Ord + Clone,

intersection

pub fn union<A>(&self, that: &RangeSetRef<T>) -> RangeSet<A>where A: Array<Item = T>, T: Ord + Clone,

union

pub fn difference<A>(&self, that: &RangeSetRef<T>) -> RangeSet<A>where A: Array<Item = T>, T: Ord + Clone,

difference

pub fn symmetric_difference<A>(&self, that: &RangeSetRef<T>) -> RangeSet<A>where A: Array<Item = T>, T: Ord + Clone,

symmetric difference (xor)

Trait Implementations

impl<T, A: Array<Item = T>> AsRef<RangeSetRef<T>> for RangeSet<A>

fn as_ref(&self) -> &RangeSetRef<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, A: Array<Item = T>> Borrow<RangeSetRef<T>> for RangeSet<A>

fn borrow(&self) -> &RangeSetRef<T>

Immutably borrows from an owned value.

impl<T: Debug> Debug for RangeSetRef<T>

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

Formats the value using the given formatter.

impl<T: Ord> Ord for RangeSetRef<T>

fn cmp(&self, other: &RangeSetRef<T>) -> Ordering

This method returns an Ordering between self and other.

impl<T: PartialEq> PartialEq<RangeSetRef<T>> for RangeSetRef<T>

fn eq(&self, other: &RangeSetRef<T>) -> 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<T: PartialOrd> PartialOrd<RangeSetRef<T>> for RangeSetRef<T>

fn partial_cmp(&self, other: &RangeSetRef<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> RefCast for RangeSetRef<T>

type From = [T]

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

impl<T: Eq> Eq for RangeSetRef<T>

impl<T> StructuralEq for RangeSetRef<T>

impl<T> StructuralPartialEq for RangeSetRef<T>