Trait IntervalIterator

Source

pub trait IntervalIterator<E: PartialOrd> {
    type IntervalIter: Iterator<Item = RangeInclusive<E>>;

    // Required method
    fn intervals(&self) -> Self::IntervalIter;

    // Provided methods
    fn card(&self) -> Option<usize>
       where E: Step { ... }
    fn contains(&self, elem: &E) -> bool { ... }
    fn diff<O, R>(&self, other: &O) -> R
       where E: Clone + Adjacent,
             O: IntervalIterator<E>,
             R: FromIterator<RangeInclusive<E>> { ... }
    fn disjoint<O: IntervalIterator<E> + ?Sized>(&self, other: &O) -> bool { ... }
    fn intersect<O, R>(&self, other: &O) -> R
       where E: Clone,
             O: IntervalIterator<E>,
             R: FromIterator<RangeInclusive<E>> { ... }
    fn subset<O: IntervalIterator<E> + ?Sized>(&self, other: &O) -> bool { ... }
    fn superset<O: IntervalIterator<E> + ?Sized>(&self, other: &O) -> bool { ... }
    fn union<O, R>(&self, other: &O) -> R
       where E: Clone,
             O: IntervalIterator<E>,
             R: FromIterator<RangeInclusive<E>> { ... }
}

Expand description

A trait that provides operations on iterators of orderdered intervals.

Required Associated Types§

Source

type IntervalIter: Iterator<Item = RangeInclusive<E>>

The type of the interval iterator.

Required Methods§

Source

fn intervals(&self) -> Self::IntervalIter

Returns an iterator over the ordered intervals.

Provided Methods§

Source

fn card(&self) -> Option<usize>
where E: Step,

Returns the number of elements contained within the RangeList.

Returns None if the number of elements would overflow usize.

Source

fn contains(&self, elem: &E) -> bool

Returns true if elem is contained in the range list.

§Examples

assert!(RangeList::from_iter([1..=4]).contains(&4));
assert!(!RangeList::from_iter([1..=4]).contains(&0));

assert!(RangeList::from_iter([1..=4, 6..=7, -5..=-3]).contains(&7));
assert!(!RangeList::from_iter([1..=4, 6..=7, -5..=-3]).contains(&0));

Source

fn diff<O, R>(&self, other: &O) -> R
where E: Clone + Adjacent, O: IntervalIterator<E>, R: FromIterator<RangeInclusive<E>>,

Compute RangeList without any of the elements in the ranges of other.

§Warning

The implementation decrements the lowest value of self and increments the largest value of self. This could cause a panic if this causes overflow in E.

Source