std::ops::RangeInclusive - Rust
Description: API documentation for the Rust `RangeInclusive` enum in crate `std`.
Keywords: rust, rustlang, rust-lang, RangeInclusive

# Enum std::ops::RangeInclusive [−] [src]

    pub enum RangeInclusive<Idx> {
        Empty {
            at: Idx,
        },
        NonEmpty {
            start: Idx,
            end: Idx,
        },
    }

🔬 This is a nightly-only experimental API. (`inclusive_range` #28237)

recently added, follows RFC

An inclusive range which is bounded at both ends: { x | start <= x <= end }. Use `start...end` (three dots) for its shorthand.

See the `contains()` method for its characterization.

# Examples

    #![feature(inclusive_range,inclusive_range_syntax)]
    fn main() {
        assert_eq!((3...5), std::ops::RangeInclusive::NonEmpty{ start: 3, end: 5 });
        assert_eq!(3+4+5, (3...5).sum());

        let arr = [0, 1, 2, 3];
        assert_eq!(arr[ ...2], [0,1,2  ]);
        assert_eq!(arr[1...2], [  1,2  ]);  // RangeInclusive
    }Run

## Variants

`Empty`
🔬 This is a nightly-only experimental API. (`inclusive_range` #28237)

recently added, follows RFC

Empty range (iteration has finished)

### Fields of `Empty`

`at: Idx` | 🔬 This is a nightly-only experimental API. (`inclusive_range` #28237) recently added, follows RFC The point at which iteration finished

`NonEmpty`
🔬 This is a nightly-only experimental API. (`inclusive_range` #28237)

recently added, follows RFC

Non-empty range (iteration will yield value(s))

### Fields of `NonEmpty`

`start: Idx` | 🔬 This is a nightly-only experimental API. (`inclusive_range` #28237) recently added, follows RFC The lower bound of the range (inclusive).
`end: Idx` | 🔬 This is a nightly-only experimental API. (`inclusive_range` #28237) recently added, follows RFC The upper bound of the range (inclusive).

## Methods

### `impl<Idx> RangeInclusive<Idx> where Idx: PartialOrd<Idx>`
[src]

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

🔬 This is a nightly-only experimental API. (`range_contains` #32311)

recently added as per RFC

# Examples

    #![feature(range_contains,inclusive_range_syntax)]
    fn main() {
        assert!( ! (3...5).contains(2));
        assert!(   (3...5).contains(3));
        assert!(   (3...5).contains(4));
        assert!(   (3...5).contains(5));
        assert!( ! (3...5).contains(6));

        assert!(   (3...3).contains(3));
        assert!( ! (3...2).contains(3));
    }Run

### `impl<A> RangeInclusive<A> where A: Step`
[src]

#### `fn step_by(self, by: A) -> StepBy<A, RangeInclusive<A>>`

🔬 This is a nightly-only experimental API. (`step_by` #27741)

recent addition

Creates an iterator with the same range, but stepping by the given amount at each iteration.

The resulting iterator handles overflow by stopping.

# Examples

    #![feature(step_by, inclusive_range_syntax)]

    let result: Vec<_> = (0...10).step_by(2).collect();
    assert_eq!(result, vec![0, 2, 4, 6, 8, 10]);Run

## Trait Implementations

### `impl<Idx> PartialEq<RangeInclusive<Idx>> for RangeInclusive<Idx> where Idx: PartialEq<Idx>`
[src]

#### `fn eq(&self, __arg_0: &RangeInclusive<Idx>) -> bool`

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, __arg_0: &RangeInclusive<Idx>) -> bool`

This method tests for `!=`.

### `impl<Idx> Clone for RangeInclusive<Idx> where Idx: Clone`
[src]

#### `fn clone(&self) -> RangeInclusive<Idx>`

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
1.0.0

Performs copy-assignment from `source`. Read more

### `impl ExactSizeIterator for RangeInclusive<u8>`
[src]

#### `fn len(&self) -> usize`
1.0.0

Returns the exact number of times the iterator will iterate. Read more

#### `fn is_empty(&self) -> bool`

🔬 This is a nightly-only experimental API. (`exact_size_is_empty` #35428)

Returns whether the iterator is empty. Read more

### `impl ExactSizeIterator for RangeInclusive<u16>`
[src]

#### `fn len(&self) -> usize`
1.0.0

Returns the exact number of times the iterator will iterate. Read more

#### `fn is_empty(&self) -> bool`

🔬 This is a nightly-only experimental API. (`exact_size_is_empty` #35428)

Returns whether the iterator is empty. Read more

### `impl ExactSizeIterator for RangeInclusive<i8>`
[src]

#### `fn len(&self) -> usize`
1.0.0

Returns the exact number of times the iterator will iterate. Read more

#### `fn is_empty(&self) -> bool`

🔬 This is a nightly-only experimental API. (`exact_size_is_empty` #35428)

Returns whether the iterator is empty. Read more

### `impl ExactSizeIterator for RangeInclusive<i16>`
[src]

#### `fn len(&self) -> usize`
1.0.0

Returns the exact number of times the iterator will iterate. Read more

#### `fn is_empty(&self) -> bool`

🔬 This is a nightly-only experimental API. (`exact_size_is_empty` #35428)

Returns whether the iterator is empty. Read more

### `impl TrustedLen for RangeInclusive<usize>`
[src]

### `impl TrustedLen for RangeInclusive<isize>`
[src]

### `impl TrustedLen for RangeInclusive<u8>`
[src]

### `impl TrustedLen for RangeInclusive<i8>`
[src]

### `impl TrustedLen for RangeInclusive<u16>`
[src]

### `impl TrustedLen for RangeInclusive<i16>`
[src]

### `impl TrustedLen for RangeInclusive<u32>`
[src]

### `impl TrustedLen for RangeInclusive<i32>`
[src]

### `impl TrustedLen for RangeInclusive<i64>`
[src]

### `impl TrustedLen for RangeInclusive<u64>`
[src]

### `impl<Idx> Eq for RangeInclusive<Idx> where Idx: Eq`
[src]

### `impl<A> Iterator for RangeInclusive<A> where A: Step,
&'a A: Add<&'a A>,
&'a A::Output == A`
[src]

#### `type Item = A`

The type of the elements being iterated over.

#### `fn next(&mut self) -> Option<A>`

Advances the iterator and returns the next value. Read more

#### `fn size_hint(&self) -> (usize, Option<usize>)`

Returns the bounds on the remaining length of the iterator. Read more

#### `fn count(self) -> usize`
1.0.0

Consumes the iterator, counting the number of iterations and returning it. Read more

#### `fn last(self) -> Option<Self::Item>`
1.0.0

Consumes the iterator, returning the last element. Read more

#### `fn nth(&mut self, n: usize) -> Option<Self::Item>`
1.0.0

Returns the `n`th element of the iterator. Read more

#### `fn chain<U>(self, other: U) -> Chain<Self, U::IntoIter> where U: IntoIterator<Item=Self::Item>`
1.0.0

Takes two iterators and creates a new iterator over both in sequence. Read more

#### `fn zip<U>(self, other: U) -> Zip<Self, U::IntoIter> where U: IntoIterator`
1.0.0

'Zips up' two iterators into a single iterator of pairs. Read more

#### `fn map<B, F>(self, f: F) -> Map<Self, F> where F: FnMut(Self::Item) -> B`
1.0.0

Takes a closure and creates an iterator which calls that closure on each element. Read more

#### `fn filter<P>(self, predicate: P) -> Filter<Self, P> where P: FnMut(&Self::Item) -> bool`
1.0.0

Creates an iterator which uses a closure to determine if an element should be yielded. Read more

#### `fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where F: FnMut(Self::Item) -> Option<B>`
1.0.0

Creates an iterator that both filters and maps. Read more

#### `fn enumerate(self) -> Enumerate<Self>`
1.0.0

Creates an iterator which gives the current iteration count as well as the next value. Read more

#### `fn peekable(self) -> Peekable<Self>`
1.0.0

Creates an iterator which can use `peek` to look at the next element of the iterator without consuming it. Read more

#### `fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where P: FnMut(&Self::Item) -> bool`
1.0.0

Creates an iterator that [`skip()`]s elements based on a predicate. Read more

#### `fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where P: FnMut(&Self::Item) -> bool`
1.0.0

Creates an iterator that yields elements based on a predicate. Read more

#### `fn skip(self, n: usize) -> Skip<Self>`
1.0.0

Creates an iterator that skips the first `n` elements. Read more

#### `fn take(self, n: usize) -> Take<Self>`
1.0.0

Creates an iterator that yields its first `n` elements. Read more

#### `fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where F: FnMut(&mut St, Self::Item) -> Option<B>`
1.0.0

An iterator adaptor similar to [`fold()`] that holds internal state and produces a new iterator. Read more

#### `fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where F: FnMut(Self::Item) -> U, U: IntoIterator`
1.0.0

Creates an iterator that works like map, but flattens nested structure. Read more

#### `fn fuse(self) -> Fuse<Self>`
1.0.0

Creates an iterator which ends after the first [`None`]. Read more

#### `fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnMut(&Self::Item) -> ()`
1.0.0

Do something with each element of an iterator, passing the value on. Read more

#### `fn by_ref(&mut self) -> &mut Self`
1.0.0

Borrows an iterator, rather than consuming it. Read more

#### `fn collect<B>(self) -> B where B: FromIterator<Self::Item>`
1.0.0

Transforms an iterator into a collection. Read more

#### `fn partition<B, F>(self, f: F) -> (B, B) where B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool`
1.0.0

Consumes an iterator, creating two collections from it. Read more

#### `fn fold<B, F>(self, init: B, f: F) -> B where F: FnMut(B, Self::Item) -> B`
1.0.0

An iterator adaptor that applies a function, producing a single, final value. Read more

#### `fn all<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool`
1.0.0

Tests if every element of the iterator matches a predicate. Read more

#### `fn any<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool`
1.0.0

Tests if any element of the iterator matches a predicate. Read more

#### `fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where P: FnMut(&Self::Item) -> bool`
1.0.0

Searches for an element of an iterator that satisfies a predicate. Read more

#### `fn position<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool`
1.0.0

Searches for an element in an iterator, returning its index. Read more

#### `fn rposition<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator`
1.0.0

Searches for an element in an iterator from the right, returning its index. Read more

#### `fn max(self) -> Option<Self::Item> where Self::Item: Ord`
1.0.0

Returns the maximum element of an iterator. Read more

#### `fn min(self) -> Option<Self::Item> where Self::Item: Ord`
1.0.0

Returns the minimum element of an iterator. Read more

#### `fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where B: Ord, F: FnMut(&Self::Item) -> B`
1.6.0

Returns the element that gives the maximum value from the specified function. Read more

#### `fn max_by<F>(self, compare: F) -> Option<Self::Item> where F: FnMut(&Self::Item, &Self::Item) -> Ordering`
1.15.0

Returns the element that gives the maximum value with respect to the specified comparison function. Read more

#### `fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where B: Ord, F: FnMut(&Self::Item) -> B`
1.6.0

Returns the element that gives the minimum value from the specified function. Read more

#### `fn min_by<F>(self, compare: F) -> Option<Self::Item> where F: FnMut(&Self::Item, &Self::Item) -> Ordering`
1.15.0

Returns the element that gives the minimum value with respect to the specified comparison function. Read more

#### `fn rev(self) -> Rev<Self> where Self: DoubleEndedIterator`
1.0.0

Reverses an iterator's direction. Read more

#### `fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Iterator<Item=(A, B)>`
1.0.0

Converts an iterator of pairs into a pair of containers. Read more

#### `fn cloned<'a, T>(self) -> Cloned<Self> where Self: Iterator<Item=&'a T>, T: 'a + Clone`
1.0.0

Creates an iterator which [`clone()`]s all of its elements. Read more

#### `fn cycle(self) -> Cycle<Self> where Self: Clone`
1.0.0

Repeats an iterator endlessly. Read more

#### `fn sum<S>(self) -> S where S: Sum<Self::Item>`
1.11.0

Sums the elements of an iterator. Read more

#### `fn product<P>(self) -> P where P: Product<Self::Item>`
1.11.0

Iterates over the entire iterator, multiplying all the elements Read more

#### `fn cmp<I>(self, other: I) -> Ordering where I: IntoIterator<Item=Self::Item>, Self::Item: Ord`
1.5.0

Lexicographically compares the elements of this `Iterator` with those of another. Read more

#### `fn partial_cmp<I>(self, other: I) -> Option<Ordering> where I: IntoIterator, Self::Item: PartialOrd<I::Item>`
1.5.0

Lexicographically compares the elements of this `Iterator` with those of another. Read more

#### `fn eq<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialEq<I::Item>`
1.5.0

Determines if the elements of this `Iterator` are equal to those of another. Read more

#### `fn ne<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialEq<I::Item>`
1.5.0

Determines if the elements of this `Iterator` are unequal to those of another. Read more

#### `fn lt<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>`
1.5.0

Determines if the elements of this `Iterator` are lexicographically less than those of another. Read more

#### `fn le<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>`
1.5.0

Determines if the elements of this `Iterator` are lexicographically less or equal to those of another. Read more

#### `fn gt<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>`
1.5.0

Determines if the elements of this `Iterator` are lexicographically greater than those of another. Read more

#### `fn ge<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>`
1.5.0

Determines if the elements of this `Iterator` are lexicographically greater than or equal to those of another. Read more

### `impl<Idx> Debug for RangeInclusive<Idx> where Idx: Debug`
[src]

#### `fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>`

Formats the value using the given formatter.

### `impl<A> FusedIterator for RangeInclusive<A> where A: Step,
&'a A: Add<&'a A>,
&'a A::Output == A`
[src]

### `impl<T> SliceIndex<T> for RangeInclusive<usize>`
1.13.0
[src]

#### `type Output = [T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

The output type returned by methods.

#### `fn get(self, slice: &[T]) -> Option<&[T]>`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a shared reference to the output at this location, if in bounds. Read more

#### `fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]>`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a mutable reference to the output at this location, if in bounds. Read more

#### `unsafe fn get_unchecked(self, slice: &[T]) -> &[T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a shared reference to the output at this location, without performing any bounds checking. Read more

#### `unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a mutable reference to the output at this location, without performing any bounds checking. Read more

#### `fn index(self, slice: &[T]) -> &[T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a shared reference to the output at this location, panicking if out of bounds. Read more

#### `fn index_mut(self, slice: &mut [T]) -> &mut [T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

Returns a mutable reference to the output at this location, panicking if out of bounds. Read more

### `impl<Idx> Hash for RangeInclusive<Idx> where Idx: Hash`
[src]

#### `fn hash<__HIdx>(&self, __arg_0: &mut __HIdx) where __HIdx: Hasher`

Feeds this value into the state given, updating the hasher as necessary.

#### `fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher`
1.3.0

Feeds a slice of this type into the state provided.

### `impl<A> DoubleEndedIterator for RangeInclusive<A> where A: Step,
&'a A: Add<&'a A>,
&'a A: Sub<&'a A>,
&'a A::Output == A,
&'a A::Output == A`
[src]

#### `fn next_back(&mut self) -> Option<A>`

Removes and returns an element from the end of the iterator. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)