W3cubDocs

/Rust

Struct std::ops::RangeInclusive

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

An 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];
assert_eq!(arr[ ..=2], [0,1,2  ]);
assert_eq!(arr[1..=2], [  1,2  ]);  // RangeInclusive

Methods

impl<Idx> RangeInclusive<Idx> [src]

ⓘImportant traits for RangeInclusive<A>
impl<A> Iterator for RangeInclusive<A> where
    A: Step, 
    type Item = A;

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

Examples

use std::ops::RangeInclusive;

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

ⓘImportant traits for &'a mut I
impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'a, R: Read + ?Sized> Read for &'a mut R
impl<'a, W: Write + ?Sized> Write for &'a mut W

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

ⓘImportant traits for &'a mut I
impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'a, R: Read + ?Sized> Read for &'a mut R
impl<'a, W: Write + ?Sized> Write for &'a mut W

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

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

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

🔬 This is a nightly-only experimental API. (range_contains #32311)recently added as per RFC

Returns true if item is contained in the range.

Examples

#![feature(range_contains)]

use std::f32;

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

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

The range is empty if either side is incomparable:

#![feature(range_is_empty)]

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

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

Trait Implementations

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

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

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

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

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

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

The type of the elements being iterated over.

Advances the iterator and returns the next value. Read more

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

Returns the nth element of the iterator. Read more

Consumes the iterator, returning the last element. Read more

Returns the minimum element of an iterator. Read more

Returns the maximum element of an iterator. Read more

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

ⓘImportant traits for StepBy<I>
impl<I> Iterator for StepBy<I> where
    I: Iterator, 
    type Item = <I as Iterator>::Item;

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

ⓘImportant traits for Chain<A, B>
impl<A, B> Iterator for Chain<A, B> where
    A: Iterator,
    B: Iterator<Item = <A as Iterator>::Item>, 
    type Item = <A as Iterator>::Item;

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

ⓘImportant traits for Zip<A, B>
impl<A, B> Iterator for Zip<A, B> where
    A: Iterator,
    B: Iterator, 
    type Item = (<A as Iterator>::Item, <B as Iterator>::Item);

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

ⓘImportant traits for Map<I, F>
impl<B, I, F> Iterator for Map<I, F> where
    F: FnMut(<I as Iterator>::Item) -> B,
    I: Iterator, 
    type Item = B;

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

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

ⓘImportant traits for Filter<I, P>
impl<I, P> Iterator for Filter<I, P> where
    I: Iterator,
    P: FnMut(&<I as Iterator>::Item) -> bool, 
    type Item = <I as Iterator>::Item;

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

ⓘImportant traits for FilterMap<I, F>
impl<B, I, F> Iterator for FilterMap<I, F> where
    F: FnMut(<I as Iterator>::Item) -> Option<B>,
    I: Iterator, 
    type Item = B;

Creates an iterator that both filters and maps. Read more

ⓘImportant traits for Enumerate<I>
impl<I> Iterator for Enumerate<I> where
    I: Iterator, 
    type Item = (usize, <I as Iterator>::Item);

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

ⓘImportant traits for Peekable<I>
impl<I> Iterator for Peekable<I> where
    I: Iterator, 
    type Item = <I as Iterator>::Item;

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

ⓘImportant traits for SkipWhile<I, P>
impl<I, P> Iterator for SkipWhile<I, P> where
    I: Iterator,
    P: FnMut(&<I as Iterator>::Item) -> bool, 
    type Item = <I as Iterator>::Item;

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

ⓘImportant traits for TakeWhile<I, P>
impl<I, P> Iterator for TakeWhile<I, P> where
    I: Iterator,
    P: FnMut(&<I as Iterator>::Item) -> bool, 
    type Item = <I as Iterator>::Item;

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

ⓘImportant traits for Skip<I>
impl<I> Iterator for Skip<I> where
    I: Iterator, 
    type Item = <I as Iterator>::Item;

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

ⓘImportant traits for Take<I>
impl<I> Iterator for Take<I> where
    I: Iterator, 
    type Item = <I as Iterator>::Item;

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

ⓘImportant traits for Scan<I, St, F>
impl<B, I, St, F> Iterator for Scan<I, St, F> where
    F: FnMut(&mut St, <I as Iterator>::Item) -> Option<B>,
    I: Iterator, 
    type Item = B;

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

ⓘImportant traits for FlatMap<I, U, F>
impl<I, U, F> Iterator for FlatMap<I, U, F> where
    F: FnMut(<I as Iterator>::Item) -> U,
    I: Iterator,
    U: IntoIterator, 
    type Item = <U as IntoIterator>::Item;

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

ⓘImportant traits for Flatten<I>
impl<I, U> Iterator for Flatten<I> where
    I: Iterator,
    U: Iterator,
    <I as Iterator>::Item: IntoIterator,
    <<I as Iterator>::Item as IntoIterator>::IntoIter == U,
    <<I as Iterator>::Item as IntoIterator>::Item == <U as Iterator>::Item, 
    type Item = <U as Iterator>::Item;

Creates an iterator that flattens nested structure. Read more

ⓘImportant traits for Fuse<I>
impl<I> Iterator for Fuse<I> where
    I: Iterator, 
    type Item = <I as Iterator>::Item;
impl<I> Iterator for Fuse<I> where
    I: FusedIterator, 

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

ⓘImportant traits for Inspect<I, F>
impl<I, F> Iterator for Inspect<I, F> where
    F: FnMut(&<I as Iterator>::Item),
    I: Iterator, 
    type Item = <I as Iterator>::Item;

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

ⓘImportant traits for &'a mut I
impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'a, R: Read + ?Sized> Read for &'a mut R
impl<'a, W: Write + ?Sized> Write for &'a mut W

Borrows an iterator, rather than consuming it. Read more

Transforms an iterator into a collection. Read more

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ⓘImportant traits for Rev<I>
impl<I> Iterator for Rev<I> where
    I: DoubleEndedIterator, 
    type Item = <I as Iterator>::Item;

Reverses an iterator's direction. Read more

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

ⓘImportant traits for Cloned<I>
impl<'a, I, T> Iterator for Cloned<I> where
    I: Iterator<Item = &'a T>,
    T: 'a + Clone, 
    type Item = T;

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

ⓘImportant traits for Cycle<I>
impl<I> Iterator for Cycle<I> where
    I: Clone + Iterator, 
    type Item = <I as Iterator>::Item;

Repeats an iterator endlessly. Read more

Sums the elements of an iterator. Read more

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

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

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

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

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

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

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

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

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

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

The output type returned by methods.

🔬 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

🔬 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

ⓘImportant traits for RangeInclusive<A>
impl<A> Iterator for RangeInclusive<A> where
    A: Step, 
    type Item = A;
🔬 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. Read more

ⓘImportant traits for RangeInclusive<A>
impl<A> Iterator for RangeInclusive<A> where
    A: Step, 
    type Item = A;
🔬 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. Read more

ⓘImportant traits for RangeInclusive<A>
impl<A> Iterator for RangeInclusive<A> where
    A: Step, 
    type Item = A;
🔬 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

ⓘImportant traits for RangeInclusive<A>
impl<A> Iterator for RangeInclusive<A> where
    A: Step, 
    type Item = A;
🔬 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<T> SliceIndex<[T]> for RangeInclusive<usize> [src]

The output type returned by methods.

🔬 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

🔬 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

ⓘImportant traits for &'a [u8]
impl<'a> Read for &'a [u8]
impl<'a> Write for &'a mut [u8]
🔬 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. Read more

ⓘImportant traits for &'a [u8]
impl<'a> Read for &'a [u8]
impl<'a> Write for &'a mut [u8]
🔬 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. Read more

ⓘImportant traits for &'a [u8]
impl<'a> Read for &'a [u8]
impl<'a> Write for &'a mut [u8]
🔬 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

ⓘImportant traits for &'a [u8]
impl<'a> Read for &'a [u8]
impl<'a> Write for &'a mut [u8]
🔬 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> Hash for RangeInclusive<Idx> where
    Idx: Hash
[src]

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

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

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

ⓘImportant traits for RangeInclusive<A>
impl<A> Iterator for RangeInclusive<A> where
    A: Step, 
    type Item = A;

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl TrustedLen for RangeInclusive<isize> [src]

impl TrustedLen for RangeInclusive<usize> [src]

impl TrustedLen for RangeInclusive<u64> [src]

impl TrustedLen for RangeInclusive<u16> [src]

impl TrustedLen for RangeInclusive<i16> [src]

impl TrustedLen for RangeInclusive<i64> [src]

impl TrustedLen for RangeInclusive<u32> [src]

impl TrustedLen for RangeInclusive<u8> [src]

impl TrustedLen for RangeInclusive<i32> [src]

impl TrustedLen for RangeInclusive<i8> [src]

impl IndexMut<RangeInclusive<usize>> for str [src]

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

impl Index<RangeInclusive<usize>> for str [src]

The returned type after indexing.

Performs the indexing (container[index]) operation.

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

Formats the value using the given formatter. Read more

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

impl ExactSizeIterator for RangeInclusive<i8> [src]

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

🔬 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]

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

🔬 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]

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

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

Returns whether the iterator is empty. Read more

impl ExactSizeIterator for RangeInclusive<u8> [src]

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

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

Returns whether the iterator is empty. Read more

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

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

This method tests for !=.

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

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

Start index bound. Read more

End index bound. Read more

🔬 This is a nightly-only experimental API. (range_contains #32311)recently added as per RFC

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

impl<'a, T> RangeBounds<T> for RangeInclusive<&'a T> [src]
1.28.0

Start index bound. Read more

End index bound. Read more

🔬 This is a nightly-only experimental API. (range_contains #32311)recently added as per RFC

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

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

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

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

The returned type after indexing.

Performs the indexing (container[index]) operation.

Auto Trait Implementations

impl<Idx> Send for RangeInclusive<Idx> where
    Idx: Send

impl<Idx> Sync for RangeInclusive<Idx> where
    Idx: Sync

Blanket Implementations

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from #33417)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from #33417)

Performs the conversion.

impl<T> From for T [src]

Performs the conversion.

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

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

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

🔬 This is a nightly-only experimental API. (try_from #33417)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from #33417)

Performs the conversion.

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

Performs the conversion.

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

ⓘImportant traits for &'a mut I
impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'a, R: Read + ?Sized> Read for &'a mut R
impl<'a, W: Write + ?Sized> Write for &'a mut W

Immutably borrows from an owned value. Read more

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

ⓘImportant traits for &'a mut I
impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'a, R: Read + ?Sized> Read for &'a mut R
impl<'a, W: Write + ?Sized> Write for &'a mut W

Mutably borrows from an owned value. Read more

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

🔬 This is a nightly-only experimental API. (get_type_id #27745)this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

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

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

🔬 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

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/ops/struct.RangeInclusive.html