Struct core::ops::RangeInclusive1.26.0[][src]

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  ]);  // RangeInclusiveRun

Methods

impl<Idx> RangeInclusive<Idx>
[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

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

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

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: PartialOrd<Idx>> RangeInclusive<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));Run

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

use std::f32::NAN;
assert!(!(3.0..=5.0).is_empty());
assert!( (3.0..=NAN).is_empty());
assert!( (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> Clone for RangeInclusive<Idx>
[src]

Important traits for RangeInclusive<A>

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

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

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

This method tests for !=.

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

impl<Idx: Hash> Hash for RangeInclusive<Idx>
[src]

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

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

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

Formats the value using the given formatter. Read more

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

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

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 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 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<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 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<A: Step> Iterator for RangeInclusive<A>
[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>

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>

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

Important traits for Zip<A, B>

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

Important traits for Map<I, F>

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>

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

Important traits for FilterMap<I, F>

Creates an iterator that both filters and maps. Read more

Important traits for Enumerate<I>

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

Important traits for Peekable<I>

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>

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

Important traits for TakeWhile<I, P>

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

Important traits for Skip<I>

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

Important traits for Take<I>

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

Important traits for Scan<I, St, F>

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

Important traits for FlatMap<I, U, F>

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

Important traits for Flatten<I>

Creates an iterator that flattens nested structure. Read more

Important traits for Fuse<I>

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

Important traits for Inspect<I, F>

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

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

🔬 This is a nightly-only experimental API. (iterator_find_map #49602)

unstable new API

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>

Reverses an iterator's direction. Read more

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

Important traits for Cloned<I>

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

Important traits for Cycle<I>

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<A: Step> DoubleEndedIterator for RangeInclusive<A>
[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: Step> FusedIterator for RangeInclusive<A>
[src]

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

🔬 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

🔬 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

🔬 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

🔬 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 Index<RangeInclusive<usize>> for str
[src]

The returned type after indexing.

Performs the indexing (container[index]) operation.

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

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

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

🔬 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

🔬 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

🔬 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

🔬 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

Auto Trait Implementations

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

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