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

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

Unstable (`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,iter_arith)] 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 }

    #![feature(inclusive_range,inclusive_range_syntax,iter_arith)]
    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
    }

## Variants

`Empty` | Unstable (`inclusive_range` #28237) : recently added, follows RFC Empty range (iteration has finished) ### Fields
`at` | Unstable (`inclusive_range` #28237) : recently added, follows RFC
`NonEmpty` | Unstable (`inclusive_range` #28237) : recently added, follows RFC Non-empty range (iteration will yield value(s)) ### Fields
`start` | Unstable (`inclusive_range` #28237) : recently added, follows RFC
`end` | Unstable (`inclusive_range` #28237) : recently added, follows RFC

## Methods

### `impl<Idx> RangeInclusive<Idx> where Idx: PartialOrd<Idx>`

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

Unstable (`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)); }

    #![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));
    }

### `impl<A> RangeInclusive<A> where A: Step`

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

Unstable (`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)] fn main() { for i in (0...10).step_by(2) { println!("{}", i); } }

    #![feature(step_by, inclusive_range_syntax)]

    for i in (0...10).step_by(2) {
        println!("{}", i);
    }

This prints:

    0
    2
    4
    6
    8
    10

## Trait Implementations

### `impl<Idx> Debug for RangeInclusive<Idx> where Idx: Debug`

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

Unstable (`inclusive_range` #28237)

: recently added, follows RFC

### `impl<Idx> From<Range<Idx>> for RangeInclusive<Idx> where Idx: One + Sub<Idx, Output=Idx> + PartialOrd<Idx>`

#### `fn from(range: Range<Idx>) -> RangeInclusive<Idx>`

Unstable (`inclusive_range` #28237)

: recently added, follows RFC

### `impl ExactSizeIterator for RangeInclusive<usize>`

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

### `impl ExactSizeIterator for RangeInclusive<u8>`

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

### `impl ExactSizeIterator for RangeInclusive<u16>`

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

### `impl ExactSizeIterator for RangeInclusive<u32>`

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

### `impl ExactSizeIterator for RangeInclusive<isize>`

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

### `impl ExactSizeIterator for RangeInclusive<i8>`

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

### `impl ExactSizeIterator for RangeInclusive<i16>`

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

### `impl ExactSizeIterator for RangeInclusive<i32>`

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

### `impl<A> Iterator for RangeInclusive<A> where A: One + Step, &'a A: Add<&'a A>, &'a A::Output == A`

#### `type Item = A`

Unstable (`inclusive_range` #28237)

: recently added, follows RFC

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

Unstable (`inclusive_range` #28237)

: recently added, follows RFC

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

Unstable (`inclusive_range` #28237)

: recently added, follows RFC

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#### `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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#### `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

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

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

#### `fn sum<S>(self) -> S where S: Add<Self::Item, Output=S> + Zero`

#### `fn product<P>(self) -> P where P: Mul<Self::Item, Output=P> + One`

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

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

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

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

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

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

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

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

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

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

Unstable (`inclusive_range` #28237)

: recently added, follows RFC

### Derived Implementations

### `impl<Idx> Eq for RangeInclusive<Idx> where Idx: Eq`

### `impl<Idx> PartialEq<RangeInclusive<Idx>> for RangeInclusive<Idx> where Idx: PartialEq<Idx>`

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

Unstable (`inclusive_range` #28237)

: recently added, follows RFC

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

Unstable (`inclusive_range` #28237)

: recently added, follows RFC

### `impl<Idx> Clone for RangeInclusive<Idx> where Idx: Clone`

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

Unstable (`inclusive_range` #28237)

: recently added, follows RFC

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

### `impl<Idx> Copy for RangeInclusive<Idx> where Idx: Copy`

# 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

## 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`)