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

# 1.26.0[−][src]Struct std::ops::RangeInclusive

    pub struct RangeInclusive<Idx> { /* fields omitted */ }

A range bounded inclusively below and above (`start..=end`).

The `RangeInclusive` `start..=end` contains all values with `x >= start` and `x <= end`. It is empty unless `start <= end`.

This iterator is fused, but the specific values of `start` and `end` after iteration has finished are unspecified other than that `.is_empty()` will return `true` once no more values will be produced.

# Examples

    assert_eq!((3..=5), std::ops::RangeInclusive::new(3, 5));
    assert_eq!(3 + 4 + 5, (3..=5).sum());

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

Run

## Implementations

### `impl<Idx> RangeInclusive<Idx>`[src]

#### `pub const fn new(start: Idx, end: Idx) -> RangeInclusive<Idx>`1.27.0[src]

Creates a new inclusive range. Equivalent to writing `start..=end`.

# Examples

    use std::ops::RangeInclusive;

    assert_eq!(3..=5, RangeInclusive::new(3, 5));

Run

#### `pub const fn start(&self) -> &Idx`1.27.0[src]

Returns the lower bound of the range (inclusive).

When using an inclusive range for iteration, the values of `start()` and `end()` are unspecified after the iteration ended. To determine whether the inclusive range is empty, use the `is_empty()` method instead of comparing `start() > end()`.

Note: the value returned by this method is unspecified after the range has been iterated to exhaustion.

# Examples

    assert_eq!((3..=5).start(), &3);

Run

#### `pub const fn end(&self) -> &Idx`1.27.0[src]

Returns the upper bound of the range (inclusive).

When using an inclusive range for iteration, the values of `start()` and `end()` are unspecified after the iteration ended. To determine whether the inclusive range is empty, use the `is_empty()` method instead of comparing `start() > end()`.

Note: the value returned by this method is unspecified after the range has been iterated to exhaustion.

# Examples

    assert_eq!((3..=5).end(), &5);

Run

#### `pub fn into_inner(self) -> (Idx, Idx)`1.27.0[src]

Destructures the `RangeInclusive` into (lower bound, upper (inclusive) bound).

Note: the value returned by this method is unspecified after the range has been iterated to exhaustion.

# Examples

    assert_eq!((3..=5).into_inner(), (3, 5));

Run

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

#### `pub fn contains<U>(&self, item: &U) -> bool where
Idx: PartialOrd<U>,
U: PartialOrd<Idx> + ?Sized,` 1.35.0[src]

Returns `true` if `item` is contained in the range.

# Examples

    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));

    assert!( (0.0..=1.0).contains(&1.0));
    assert!(!(0.0..=1.0).contains(&f32::NAN));
    assert!(!(0.0..=f32::NAN).contains(&0.0));
    assert!(!(f32::NAN..=1.0).contains(&1.0));

Run

#### `pub fn is_empty(&self) -> bool`[src]

🔬 This is a nightly-only experimental API. (`range_is_empty` #48111)

recently added

Returns `true` if the range contains no items.

# Examples

    #![feature(range_is_empty)]

    assert!(!(3..=5).is_empty());
    assert!(!(3..=3).is_empty());
    assert!( (3..=2).is_empty());

Run

The range is empty if either side is incomparable:

    #![feature(range_is_empty)]

    assert!(!(3.0..=5.0).is_empty());
    assert!( (3.0..=f32::NAN).is_empty());
    assert!( (f32::NAN..=5.0).is_empty());

Run

This method returns `true` after iteration has finished:

    #![feature(range_is_empty)]

    let mut r = 3..=5;
    for _ in r.by_ref() {}
    // Precise field values are unspecified here
    assert!(r.is_empty());

Run

## Trait Implementations

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

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

Returns a copy of the value. Read more

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

Performs copy-assignment from `source`. Read more

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

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

Formats the value using the given formatter. Read more

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

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

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

#### `fn nth_back(&mut self, n: usize) -> Option<A>`[src]

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

#### `fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, <RangeInclusive<A> as Iterator>::Item) -> R,
R: Try<Ok = B>,
RangeInclusive<A>: Sized,` [src]

This is the reverse version of [`try_fold()`]: it takes elements starting from the back of the iterator. Read more

#### `fn rfold<B, F>(self, init: B, f: F) -> B where
F: FnMut(B, <RangeInclusive<A> as Iterator>::Item) -> B,
RangeInclusive<A>: Sized,` [src]

An iterator method that reduces the iterator's elements to a single, final value, starting from the back. Read more

#### `fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,` 1.27.0[src]

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

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

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

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

Returns the exact length of the iterator. Read more

#### `fn is_empty(&self) -> bool`[src]

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

Returns `true` if the iterator is empty. Read more

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

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

Returns the exact length of the iterator. Read more

#### `fn is_empty(&self) -> bool`[src]

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

Returns `true` if the iterator is empty. Read more

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

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

Returns the exact length of the iterator. Read more

#### `fn is_empty(&self) -> bool`[src]

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

Returns `true` if the iterator is empty. Read more

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

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

Returns the exact length of the iterator. Read more

#### `fn is_empty(&self) -> bool`[src]

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

Returns `true` if the iterator is empty. Read more

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

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

#### `fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,` [src]

Feeds this value into the given [`Hasher`]. Read more

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

Feeds a slice of this type into the given [`Hasher`]. Read more

### `impl Index<RangeInclusive<usize>> for String`[src]

#### `type Output = str`

The returned type after indexing.

#### `fn index(&self, index: RangeInclusive<usize>) -> &str`[src]

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

### `impl IndexMut<RangeInclusive<usize>> for String`[src]

#### `fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut str`[src]

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

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

#### `type Item = A`

The type of the elements being iterated over.

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

Advances the iterator and returns the next value. Read more

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

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

#### `fn nth(&mut self, n: usize) -> Option<A>`[src]

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

#### `fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, <RangeInclusive<A> as Iterator>::Item) -> R,
R: Try<Ok = B>,
RangeInclusive<A>: Sized,` [src]

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more

#### `fn fold<B, F>(self, init: B, f: F) -> B where
F: FnMut(B, <RangeInclusive<A> as Iterator>::Item) -> B,
RangeInclusive<A>: Sized,` [src]

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

#### `fn last(self) -> Option<A>`[src]

Consumes the iterator, returning the last element. Read more

#### `fn min(self) -> Option<A>`[src]

Returns the minimum element of an iterator. Read more

#### `fn max(self) -> Option<A>`[src]

Returns the maximum element of an iterator. Read more

#### `fn count(self) -> usize`1.0.0[src]

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

#### `fn step_by(self, step: usize) -> StepBy<Self>`1.28.0[src]

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more

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

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

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

'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[src]

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

#### `fn for_each<F>(self, f: F) where
F: FnMut(Self::Item),` 1.21.0[src]

Calls a closure on each element of an iterator. Read more

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

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[src]

Creates an iterator that both filters and maps. Read more

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

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[src]

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[src]

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[src]

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

#### `fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P> where
P: FnMut(Self::Item) -> Option<B>,` [src]

🔬 This is a nightly-only experimental API. (`iter_map_while` #68537)

recently added

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

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

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

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

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[src]

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[src]

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

#### `fn flatten(self) -> Flatten<Self> where
Self::Item: IntoIterator,` 1.29.0[src]

Creates an iterator that flattens nested structure. Read more

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

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[src]

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

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

Borrows an iterator, rather than consuming it. Read more

#### `#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]fn collect<B>(self) -> B where
B: FromIterator<Self::Item>,` 1.0.0[src]

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[src]

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

#### `fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
P: FnMut(&T) -> bool,
Self: DoubleEndedIterator<Item = &'a mut T>,
T: 'a,` [src]

🔬 This is a nightly-only experimental API. (`iter_partition_in_place` #62543)

new API

Reorders the elements of this iterator in-place according to the given predicate, such that all those that return `true` precede all those that return `false`. Returns the number of `true` elements found. Read more

#### `fn is_partitioned<P>(self, predicate: P) -> bool where
P: FnMut(Self::Item) -> bool,` [src]

🔬 This is a nightly-only experimental API. (`iter_is_partitioned` #62544)

new API

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return `true` precede all those that return `false`. Read more

#### `fn try_for_each<F, R>(&mut self, f: F) -> R where
F: FnMut(Self::Item) -> R,
R: Try<Ok = ()>,` 1.27.0[src]

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more

#### `fn fold_first<F>(self, f: F) -> Option<Self::Item> where
F: FnMut(Self::Item, Self::Item) -> Self::Item,` [src]

🔬 This is a nightly-only experimental API. (`iterator_fold_self` #68125)

The same as `fold()`, but uses the first element in the iterator as the initial value, folding every subsequent element into it. If the iterator is empty, return `None`; otherwise, return the result of the fold. Read more

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

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[src]

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[src]

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

#### `fn find_map<B, F>(&mut self, f: F) -> Option<B> where
F: FnMut(Self::Item) -> Option<B>,` 1.30.0[src]

Applies function to the elements of iterator and returns the first non-none result. Read more

#### `fn try_find<F, R>(
&mut self,
f: F
) -> Result<Option<Self::Item>, <R as Try>::Error> where
F: FnMut(&Self::Item) -> R,
R: Try<Ok = bool>,` [src]

🔬 This is a nightly-only experimental API. (`try_find` #63178)

new API

Applies function to the elements of iterator and returns the first true result or the first error. Read more

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

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[src]

Searches for an element in an iterator from the right, returning its index. 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[src]

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[src]

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[src]

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[src]

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[src]

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[src]

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

#### `fn copied<'a, T>(self) -> Copied<Self> where
Self: Iterator<Item = &'a T>,
T: 'a + Copy,` 1.36.0[src]

Creates an iterator which copies all of its elements. Read more

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

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

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

Repeats an iterator endlessly. Read more

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

Sums the elements of an iterator. Read more

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

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[src]

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

#### `fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
I: IntoIterator,` [src]

🔬 This is a nightly-only experimental API. (`iter_order_by` #64295)

Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more

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

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

#### `fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
I: IntoIterator,` [src]

🔬 This is a nightly-only experimental API. (`iter_order_by` #64295)

Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more

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

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

#### `fn eq_by<I, F>(self, other: I, eq: F) -> bool where
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
I: IntoIterator,` [src]

🔬 This is a nightly-only experimental API. (`iter_order_by` #64295)

Determines if the elements of this `Iterator` are equal to those of another with respect to the specified equality function. Read more

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

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 as IntoIterator>::Item>,` 1.5.0[src]

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 as IntoIterator>::Item>,` 1.5.0[src]

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 as IntoIterator>::Item>,` 1.5.0[src]

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 as IntoIterator>::Item>,` 1.5.0[src]

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

#### `fn is_sorted(self) -> bool where
Self::Item: PartialOrd<Self::Item>,` [src]

🔬 This is a nightly-only experimental API. (`is_sorted` #53485)

new API

Checks if the elements of this iterator are sorted. Read more

#### `fn is_sorted_by<F>(self, compare: F) -> bool where
F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>,` [src]

🔬 This is a nightly-only experimental API. (`is_sorted` #53485)

new API

Checks if the elements of this iterator are sorted using the given comparator function. Read more

#### `fn is_sorted_by_key<F, K>(self, f: F) -> bool where
F: FnMut(Self::Item) -> K,
K: PartialOrd<K>,` [src]

🔬 This is a nightly-only experimental API. (`is_sorted` #53485)

new API

Checks if the elements of this iterator are sorted using the given key extraction function. Read more

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

#### `fn eq(&self, other: &RangeInclusive<Idx>) -> bool`[src]

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

#### `fn ne(&self, other: &RangeInclusive<Idx>) -> bool`[src]

This method tests for `!=`.

### `impl<T> RangeBounds<T> for RangeInclusive<T>`1.28.0[src]

#### `fn start_bound(&self) -> Bound<&T>`[src]

Start index bound. Read more

#### `fn end_bound(&self) -> Bound<&T>`[src]

End index bound. Read more

#### `fn contains<U>(&self, item: &U) -> bool where
T: PartialOrd<U>,
U: PartialOrd<T> + ?Sized,` 1.35.0[src]

Returns `true` if `item` is contained in the range. Read more

### `impl<'_, T> RangeBounds<T> for RangeInclusive<&'_ T>`1.28.0[src]

#### `fn start_bound(&self) -> Bound<&T>`[src]

Start index bound. Read more

#### `fn end_bound(&self) -> Bound<&T>`[src]

End index bound. Read more

#### `fn contains<U>(&self, item: &U) -> bool where
T: PartialOrd<U>,
U: PartialOrd<T> + ?Sized,` 1.35.0[src]

Returns `true` if `item` is contained in the range. Read more

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

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

The output type returned by methods.

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

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

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]>`[src]

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

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

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

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

Returns a shared reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-bounds index is [undefined behavior] even if the resulting reference is not used. Read more

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

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

Returns a mutable reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-bounds index is [undefined behavior] even if the resulting reference is not used. Read more

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

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

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]`[src]

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

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

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

Implements substring slicing with syntax `&self[begin ..= end]` or `&mut self[begin ..= end]`.

Returns a slice of the given string from the byte range [`begin`, `end`]. Equivalent to `&self [begin .. end + 1]` or `&mut self[begin .. end + 1]`, except if `end` has the maximum value for `usize`.

This operation is `O(1)`.

# Panics

Panics if `begin` does not point to the starting byte offset of a character (as defined by `is_char_boundary`), if `end` does not point to the ending byte offset of a character (`end + 1` is either a starting byte offset or equal to `len`), if `begin > end`, or if `end >= len`.

#### `type Output = str`

The output type returned by methods.

#### `fn get(
self,
slice: &str
) -> Option<&<RangeInclusive<usize> as SliceIndex<str>>::Output>`[src]

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

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

#### `fn get_mut(
self,
slice: &mut str
) -> Option<&mut <RangeInclusive<usize> as SliceIndex<str>>::Output>`[src]

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

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

#### `unsafe fn get_unchecked(
self,
slice: &str
) -> &<RangeInclusive<usize> as SliceIndex<str>>::Output`[src]

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

Returns a shared reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-bounds index is [undefined behavior] even if the resulting reference is not used. Read more

#### `unsafe fn get_unchecked_mut(
self,
slice: &mut str
) -> &mut <RangeInclusive<usize> as SliceIndex<str>>::Output`[src]

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

Returns a mutable reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-bounds index is [undefined behavior] even if the resulting reference is not used. Read more

#### `fn index(
self,
slice: &str
) -> &<RangeInclusive<usize> as SliceIndex<str>>::Output`[src]

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

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

#### `fn index_mut(
self,
slice: &mut str
) -> &mut <RangeInclusive<usize> as SliceIndex<str>>::Output`[src]

🔬 This is a nightly-only experimental API. (`slice_index_methods`)

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

### `impl<Idx> StructuralEq for RangeInclusive<Idx>`[src]

### `impl<Idx> StructuralPartialEq for RangeInclusive<Idx>`[src]

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

## Auto Trait Implementations

### `impl<Idx> RefUnwindSafe for RangeInclusive<Idx> where
Idx: RefUnwindSafe,`

### `impl<Idx> Send for RangeInclusive<Idx> where
Idx: Send,`

### `impl<Idx> Sync for RangeInclusive<Idx> where
Idx: Sync,`

### `impl<Idx> Unpin for RangeInclusive<Idx> where
Idx: Unpin,`

### `impl<Idx> UnwindSafe for RangeInclusive<Idx> where
Idx: UnwindSafe,`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<I> IntoIterator for I where
I: Iterator,` [src]

#### `type Item = <I as Iterator>::Item`

The type of the elements being iterated over.

#### `type IntoIter = I`

Which kind of iterator are we turning this into?

#### `fn into_iter(self) -> I`[src]

Creates an iterator from a value. Read more

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.