Struct Range 

pub struct Range<Idx> {
    pub start: Idx,
    pub end: RangeEnd<Idx>,
}

A range bounded on both ends, with an inclusive start and an end whose inclusivity is recorded by RangeEnd.

Ordering is lexicographic: by start first, then by end.

Examples

use ps_range::Range;

assert_eq!(Range::from(2..7), Range::exclusive(2, 7));
assert_ne!(Range::inclusive(2, 6), Range::exclusive(2, 7));

Fields

start: Idx

The inclusive lower bound.

end: RangeEnd<Idx>

The upper bound, either inclusive or exclusive.

Implementations

impl<Idx> Range<Idx>

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

Creates a range from a start index and an upper bound.

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

Creates the range start..=end.

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

Creates the range start..end.

Trait Implementations

impl<Idx: Clone> Clone for Range<Idx>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Idx: Copy> Copy for Range<Idx>

impl<Idx: Debug> Debug for Range<Idx>

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

Formats the value using the given formatter.

impl<Idx: Eq> Eq for Range<Idx>

impl<Idx> From<Range<Idx>> for PartialRange<Idx>

fn from(value: Range<Idx>) -> Self

Converts to this type from the input type.

impl<Idx> From<Range<Idx>> for Range<Idx>

fn from(value: Range<Idx>) -> Self

Converts to this type from the input type.

impl<Idx: Clone + PartialOrd> From<RangeInclusive<Idx>> for Range<Idx>

Converts the range, canonicalizing an empty source to an empty exclusive range at its start. The endpoint values of a drained std::ops::RangeInclusive are unspecified, so the position of the resulting empty range is likewise unspecified; only emptiness is guaranteed.

fn from(value: RangeInclusive<Idx>) -> Self

Converts to this type from the input type.

impl<Idx: Hash> Hash for Range<Idx>

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> IntoIterator for Range<Idx>

where Idx: CheckedAdd + Clone + One + PartialOrd,

type Item = Idx

The type of the elements being iterated over.

type IntoIter = PartialRange<Idx>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Idx: Ord> Ord for Range<Idx>

fn cmp(&self, other: &Range<Idx>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Idx: PartialEq> PartialEq for Range<Idx>

fn eq(&self, other: &Range<Idx>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<Idx: PartialOrd> PartialOrd for Range<Idx>

fn partial_cmp(&self, other: &Range<Idx>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<Idx: Clone + Ord> PartialRangeExt<Idx> for Range<Idx>

fn end_bound(&self) -> Option<RangeEnd<Idx>>

Returns the upper bound, or None if the range is unbounded above.

fn is_empty(&self) -> bool

Returns true if the range contains no indices.

fn clamp_exclusive( &self, start: impl Into<Idx>, exclusive_end: impl Into<Idx>, ) -> Range<Idx>

where Idx: Add<Output = Idx> + One,

Restricts the range to the window start..exclusive_end.

fn clamp_inclusive( &self, start: impl Into<Idx>, inclusive_end: impl Into<Idx>, ) -> Range<Idx>

Restricts the range to the window start..=inclusive_end.

fn clamp_right_inclusive(&self, inclusive_end: impl Into<Idx>) -> Range<Idx>

Caps the upper bound at inclusive_end.

fn clamp_right_exclusive(&self, exclusive_end: impl Into<Idx>) -> Range<Idx>

where Idx: Add<Output = Idx> + One,

Caps the upper bound at exclusive_end.

fn clamp_left(&self, start: impl Into<Idx>) -> PartialRange<Idx>

Raises the lower bound to at least start, preserving boundedness above.

fn intersection<R>(&self, other: &R) -> PartialRange<Idx>

where R: PartialRangeExt<Idx>,

Returns the overlap between this range and other.

impl<Idx> RangeExt<Idx> for Range<Idx>

where Idx: Clone + Ord + One + CheckedAdd + SaturatingSub,

fn end_inclusive(&self) -> Idx

Returns the inclusive upper bound.

fn end_exclusive(&self) -> Option<Idx>

Returns the exclusive upper bound, or None if it would exceed the maximum index value, that is, if the range ends inclusively at the maximum.

fn clamp_to(&self, start: impl Into<Idx>, end: impl Into<Idx>) -> Range<Idx>

Restricts the range to the bounds start..end.

fn clamp_right(&self, end: impl Into<Idx>) -> Range<Idx>

Lowers the upper bound to at most end.

impl<Idx: Clone> RangeStart<Idx> for Range<Idx>

fn start(&self) -> Idx

Returns the inclusive lower bound of the range.

impl<Idx: PartialEq> StructuralPartialEq for Range<Idx>