Struct BoundedRange

pub struct BoundedRange<T> {
    pub start: LowerBound<T>,
    pub end: UpperBound<T>,
}

A range bounded both below and above (either inclusive or exclusive).

Generalizes over std::ops::Range and std::ops::RangeInclusive but also supports ranges with an exclusive lower bound.

While a BoundedRange can be constructed from one of the above types, it will most likely result from one or more range operations.

use rangetools::{BoundedRange, LowerBound, Rangetools, UpperBound};

let i = (0..5).intersection(3..7);
assert_eq!(i, BoundedRange { start: LowerBound::included(3), end: UpperBound::excluded(5) });

The range is empty if the start bound is greater than the end bound. Note that a range with start bound Bound::Excluded(3) and end bound Bound::Excluded(4) is not considered empty even though it doesn’t contain any values.

Fields

start: LowerBound<T>

The lower bound of the range (can be inclusive or exclusive).

end: UpperBound<T>

The upper bound of the range (can be inclusive or exclusive).

Implementations

impl<T: Copy + Ord> BoundedRange<T>

pub fn new(start: LowerBound<T>, end: UpperBound<T>) -> Self

Constructs a new BoundedRange from a lower bound and an upper bound.

Example

use rangetools::{BoundedRange, LowerBound, UpperBound};

let r = BoundedRange::new(LowerBound::included(0), UpperBound::included(10));
assert!(r.contains(5));

pub fn contains(&self, t: T) -> bool

Returns true if the range contains t.

Example

use rangetools::Rangetools;

let r = (1..10).intersection(5..7);
assert!(r.contains(5));
assert!(!r.contains(3));

Trait Implementations

impl<T: Clone> Clone for BoundedRange<T>

fn clone(&self) -> BoundedRange<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BoundedRange<T>

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

Formats the value using the given formatter.

impl<T: Copy + Ord> From<BoundedRange<T>> for BoundedSet<T>

fn from(r: BoundedRange<T>) -> Self

Converts to this type from the input type.

impl<T> From<BoundedRange<T>> for Range<T>

where T: Copy + Step,

fn from(r: BoundedRange<T>) -> Self

Converts to this type from the input type.

impl<T> From<BoundedRange<T>> for RangeInclusive<T>

where T: Copy + Step,

fn from(r: BoundedRange<T>) -> Self

Converts to this type from the input type.

impl<T> From<Range<T>> for BoundedRange<T>

fn from(r: Range<T>) -> Self

Converts to this type from the input type.

impl<T> From<RangeInclusive<T>> for BoundedRange<T>

fn from(r: RangeInclusive<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for BoundedRange<T>

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<T> Index<BoundedRange<usize>> for [T]

type Output = [T]

The returned type after indexing.

fn index(&self, r: BoundedRange<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<BoundedRange<usize>> for String

type Output = str

The returned type after indexing.

fn index(&self, r: BoundedRange<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<BoundedRange<usize>> for Vec<T>

type Output = [T]

The returned type after indexing.

fn index(&self, r: BoundedRange<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<BoundedRange<usize>> for str

type Output = str

The returned type after indexing.

fn index(&self, r: BoundedRange<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<BoundedRange<usize>> for [T]

fn index_mut(&mut self, r: BoundedRange<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<BoundedRange<usize>> for String

fn index_mut(&mut self, r: BoundedRange<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<BoundedRange<usize>> for Vec<T>

fn index_mut(&mut self, r: BoundedRange<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<BoundedRange<usize>> for str

fn index_mut(&mut self, r: BoundedRange<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> IntoIterator for BoundedRange<T>

where T: Copy + Ord + Step,

type IntoIter = BoundedRangeIter<T>

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for BoundedRange<T>

fn eq(&self, other: &BoundedRange<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> RangeComplement<UnboundedSet<T>> for BoundedRange<T>

where T: Copy + Ord,

fn complement(self) -> UnboundedSet<T>

Returns a set of all the elements not in self.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for BoundedRange<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for BoundedSet<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedSet<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for LowerBoundedRange<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for LowerBoundedSet<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedSet<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for Range<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for RangeFrom<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for RangeFull

where R: Rangetools<Inner = BoundedRange<T>>,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for RangeInclusive<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for RangeTo<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for RangeToInclusive<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for UnboundedSet<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedSet<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for UpperBoundedRange<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedRange<T>> for UpperBoundedSet<T>

where R: Rangetools<Inner = BoundedRange<T>>, T: Copy + Ord,

type Output = BoundedSet<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, BoundedSet<T>> for BoundedRange<T>

where R: Rangetools<Inner = BoundedSet<T>>, T: Copy + Ord,

type Output = BoundedSet<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, EmptyRange<T>> for BoundedRange<T>

where R: Rangetools<Inner = EmptyRange<T>>, T: Copy + Ord,

type Output = EmptyRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, LowerBoundedRange<T>> for BoundedRange<T>

where R: Rangetools<Inner = LowerBoundedRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, LowerBoundedSet<T>> for BoundedRange<T>

where R: Rangetools<Inner = LowerBoundedSet<T>>, T: Copy + Ord,

type Output = BoundedSet<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, UnboundedRange> for BoundedRange<T>

where R: Rangetools<Inner = UnboundedRange>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, UnboundedSet<T>> for BoundedRange<T>

where R: Rangetools<Inner = UnboundedSet<T>>, T: Copy + Ord,

type Output = BoundedSet<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, UpperBoundedRange<T>> for BoundedRange<T>

where R: Rangetools<Inner = UpperBoundedRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeIntersection<R, UpperBoundedSet<T>> for BoundedRange<T>

where R: Rangetools<Inner = UpperBoundedSet<T>>, T: Copy + Ord,

type Output = BoundedSet<T>

The output type of the intersection.

fn intersection(self, other: R) -> Self::Output

Returns the set intersection of self and other.

impl<T, R> RangeUnion<R, BoundedSet<T>> for BoundedRange<T>

where R: Rangetools<Set = BoundedSet<T>>, T: Copy + Ord,

type Output = BoundedSet<T>

The output type of the union.

fn union(self, other: R) -> Self::Output

Returns the set union of self and other.

impl<T, R> RangeUnion<R, EmptyRange<T>> for BoundedRange<T>

where R: Rangetools<Set = EmptyRange<T>>, T: Copy + Ord,

type Output = BoundedRange<T>

The output type of the union.

fn union(self, other: R) -> Self::Output

Returns the set union of self and other.

impl<T, R> RangeUnion<R, LowerBoundedSet<T>> for BoundedRange<T>

where R: Rangetools<Set = LowerBoundedSet<T>>, T: Copy + Ord,

type Output = LowerBoundedSet<T>

The output type of the union.

fn union(self, other: R) -> Self::Output

Returns the set union of self and other.

impl<T, R> RangeUnion<R, UnboundedRange> for BoundedRange<T>

where R: Rangetools<Set = UnboundedRange>, T: Copy + Ord,

type Output = UnboundedRange

The output type of the union.

fn union(self, other: R) -> Self::Output

Returns the set union of self and other.

impl<T, R> RangeUnion<R, UnboundedSet<T>> for BoundedRange<T>

where R: Rangetools<Set = UnboundedSet<T>>, T: Copy + Ord,

type Output = UnboundedSet<T>

The output type of the union.

fn union(self, other: R) -> Self::Output

Returns the set union of self and other.

impl<T, R> RangeUnion<R, UpperBoundedSet<T>> for BoundedRange<T>

where R: Rangetools<Set = UpperBoundedSet<T>>, T: Copy + Ord,

type Output = UpperBoundedSet<T>

The output type of the union.

fn union(self, other: R) -> Self::Output

Returns the set union of self and other.

impl<T: Copy + Ord> Rangetools for BoundedRange<T>

type Inner = BoundedRange<T>

The generalized type of the range (for consolidating range types that only differ in whether their bounds are inclusive or exclusive).

type Set = BoundedSet<T>

The set type of the range, for talking about non-contiguous collections of elements.

fn is_empty(&self) -> bool

Returns true if the range is empty.

fn to_inner(self) -> Self::Inner

Convert the range to its inner type.

fn to_set(self) -> Self::Set

Convert the range to its set type.

fn complement<Output>(self) -> Output

where Self: Sized + RangeComplement<Output>,

Returns the complement of self (ie, the set of all elements not in self).

fn intersection<R, Output>(self, other: R) -> Output

where R: Rangetools, Self: Sized + RangeIntersection<R, R::Inner, Output = Output>,

Performs set intersection on self and other.

fn disjoint<R, Output>(self, other: R) -> bool

where R: Rangetools, Output: Rangetools, Self: Sized + RangeIntersection<R, R::Inner, Output = Output>,

Returns true if two sets/ranges are disjoint (they have no elements in common).

fn intersects<R, Output>(self, other: R) -> bool

where R: Rangetools, Output: Rangetools, Self: Sized + RangeIntersection<R, R::Inner, Output = Output>,

Returns true if two sets/ranges intersect (they have at least one element in common).

fn union<R, Output>(self, other: R) -> Output

where R: Rangetools, Self: Sized + RangeUnion<R, R::Set, Output = Output>,

Performs set union on self and other.

impl<T: Copy> Copy for BoundedRange<T>

impl<T: Eq> Eq for BoundedRange<T>

impl<T> StructuralPartialEq for BoundedRange<T>