W3cubDocs

/Rust

Struct RangeInclusive

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

🔬This is a nightly-only experimental API. (new_range_api #125687)

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

The start..=end syntax is a RangeInclusive:

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   ]); // This is a `RangeInclusive`

Implementations

Source

impl<Idx> RangeInclusive<Idx>

1.27.0 (const: 1.32.0)Source

pub const fn new(start: Idx, end: Idx) -> RangeInclusive<Idx> ⓘ

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

Examples

use std::ops::RangeInclusive;

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

1.27.0 (const: 1.32.0)Source

pub const fn start(&self) -> &Idx

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

1.27.0 (const: 1.32.0)Source

pub const fn end(&self) -> &Idx

Returns the upper bound of the range (inclusive).

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

Examples

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

1.27.0 (const: unstable)Source

pub fn into_inner(self) -> (Idx, Idx)

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

Source

impl<Idx> RangeInclusive<Idx>where
    Idx: PartialOrd,

1.35.0 (const: unstable)Source

pub fn contains<U>(&self, item: &U) -> boolwhere
    Idx: PartialOrd<U>,
    U: PartialOrd<Idx> + ?Sized,

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

This method always returns false after iteration has finished:

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

1.47.0 (const: unstable)Source

pub fn is_empty(&self) -> boolwhere
    Idx: PartialOrd,

Returns true if the range contains no items.

Examples

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

The range is empty if either side is incomparable:

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

This method returns true after iteration has finished:

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

Trait Implementations

1.26.0Source

impl<Idx> Clone for RangeInclusive<Idx>where
    Idx: Clone,

Source

fn clone(&self) -> RangeInclusive<Idx> ⓘ

Returns a duplicate of the value. Read more

1.0.0Source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

1.26.0Source

impl<Idx> Debug for RangeInclusive<Idx>where
    Idx: Debug,

Source

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

1.26.0Source

impl<A> DoubleEndedIterator for RangeInclusive<A>where
    A: Step,

Source

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

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

Source

fn nth_back(&mut self, n: usize) -> Option<A>

Returns the nth element from the end of the iterator. Read more

Source

fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> Rwhere
    RangeInclusive<A>: Sized,
    F: FnMut(B, <RangeInclusive<A> as Iterator>::Item) -> R,
    R: Try<Output = B>,

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

Source

fn rfold<AAA, FFF>(self, init: AAA, fold: FFF) -> AAAwhere
    FFF: FnMut(AAA, <RangeInclusive<A> as Iterator>::Item) -> AAA,

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

Source

fn advance_back_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by #77404)

Advances the iterator from the back by n elements. Read more

1.27.0Source

fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item>where
    Self: Sized,
    P: FnMut(&Self::Item) -> bool,

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

1.26.0Source

impl ExactSizeIterator for RangeInclusive<i16>

1.0.0Source

fn len(&self) -> usize

Returns the exact remaining length of the iterator. Read more

Source

fn is_empty(&self) -> bool

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

Returns true if the iterator is empty. Read more

1.26.0Source

impl ExactSizeIterator for RangeInclusive<i8>

1.0.0Source

fn len(&self) -> usize

Returns the exact remaining length of the iterator. Read more

Source

fn is_empty(&self) -> bool

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

Returns true if the iterator is empty. Read more

1.26.0Source

impl ExactSizeIterator for RangeInclusive<u16>

1.0.0Source

fn len(&self) -> usize

Returns the exact remaining length of the iterator. Read more

Source

fn is_empty(&self) -> bool

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

Returns true if the iterator is empty. Read more

1.26.0Source

impl ExactSizeIterator for RangeInclusive<u8>

1.0.0Source

fn len(&self) -> usize

Returns the exact remaining length of the iterator. Read more

Source

fn is_empty(&self) -> bool

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

Returns true if the iterator is empty. Read more

Source

impl<T> From<RangeInclusive<T>> for RangeInclusive<T>

Source

fn from(value: RangeInclusive<T>) -> RangeInclusive<T> ⓘ

Converts to this type from the input type.

Source

impl<T> From<RangeInclusive<T>> for RangeInclusive<T>

Source

fn from(value: RangeInclusive<T>) -> RangeInclusive<T>

Converts to this type from the input type.

Source

impl GetDisjointMutIndex for RangeInclusive<usize>

Source

fn is_in_bounds(&self, len: usize) -> bool

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

Returns true if self is in bounds for len slice elements.

Source

fn is_overlapping(&self, other: &RangeInclusive<usize>) -> bool

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

Returns true if self overlaps with other. Read more

1.26.0Source

impl<Idx> Hash for RangeInclusive<Idx>where
    Idx: Hash,

Source

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0Source

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

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

Source

impl Index<RangeInclusive<usize>> for ByteString

Source

type Output = ByteStr

The returned type after indexing.

Source

fn index(&self, r: RangeInclusive<usize>) -> &ByteStr

Performs the indexing (container[index]) operation. Read more

Source

impl IndexMut<RangeInclusive<usize>> for ByteString

Source

fn index_mut(&mut self, r: RangeInclusive<usize>) -> &mut ByteStr

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

Source

impl<T> IntoBounds<T> for RangeInclusive<T>

Source

fn into_bounds(self) -> (Bound<T>, Bound<T>)

🔬This is a nightly-only experimental API. (range_into_bounds #136903)

Convert this range into the start and end bounds. Returns (start_bound, end_bound). Read more

Source

fn intersect<R>(self, other: R) -> (Bound<T>, Bound<T>)where
    Self: Sized,
    T: Ord,
    R: IntoBounds<T>,

🔬This is a nightly-only experimental API. (range_into_bounds #136903)

Compute the intersection of self and other. Read more

1.26.0Source

impl<A> Iterator for RangeInclusive<A>where
    A: Step,

Source

type Item = A

The type of the elements being iterated over.

Source

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

Advances the iterator and returns the next value. Read more

Source

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

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

Source

fn count(self) -> usize

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

Source

fn nth(&mut self, n: usize) -> Option<A>

Returns the nth element of the iterator. Read more

Source

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> Rwhere
    RangeInclusive<A>: Sized,
    F: FnMut(B, <RangeInclusive<A> as Iterator>::Item) -> R,
    R: Try<Output = B>,

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

Source

fn fold<AAA, FFF>(self, init: AAA, fold: FFF) -> AAAwhere
    FFF: FnMut(AAA, <RangeInclusive<A> as Iterator>::Item) -> AAA,

Folds every element into an accumulator by applying an operation, returning the final result. Read more

Source

fn last(self) -> Option<A>

Consumes the iterator, returning the last element. Read more

Source

fn min(self) -> Option<A>where
    A: Ord,

Returns the minimum element of an iterator. Read more

Source

fn max(self) -> Option<A>where
    A: Ord,

Returns the maximum element of an iterator. Read more

Source

fn is_sorted(self) -> bool

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

Source

fn next_chunk<const N: usize>(
    &mut self,
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
    Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk #98326)

Advances the iterator and returns an array containing the next N values. Read more

Source

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by #77404)

Advances the iterator by n elements. Read more

1.28.0Source

fn step_by(self, step: usize) -> StepBy<Self> ⓘwhere
    Self: Sized,

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

1.0.0Source

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> ⓘwhere
    Self: Sized,
    U: IntoIterator<Item = Self::Item>,

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

1.0.0Source

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> ⓘwhere
    Self: Sized,
    U: IntoIterator,

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

Source

fn intersperse(self, separator: Self::Item) -> Intersperse<Self> ⓘwhere
    Self: Sized,
    Self::Item: Clone,

🔬This is a nightly-only experimental API. (iter_intersperse #79524)

Creates a new iterator which places a copy of separator between adjacent items of the original iterator. Read more

Source

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> ⓘwhere
    Self: Sized,
    G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse #79524)

Creates a new iterator which places an item generated by separator between adjacent items of the original iterator. Read more

1.0.0Source

fn map<B, F>(self, f: F) -> Map<Self, F> ⓘwhere
    Self: Sized,
    F: FnMut(Self::Item) -> B,

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

1.21.0Source

fn for_each<F>(self, f: F)where
    Self: Sized,
    F: FnMut(Self::Item),

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

1.0.0Source

fn filter<P>(self, predicate: P) -> Filter<Self, P> ⓘwhere
    Self: Sized,
    P: FnMut(&Self::Item) -> bool,

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

1.0.0Source

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> ⓘwhere
    Self: Sized,
    F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps. Read more

1.0.0Source

fn enumerate(self) -> Enumerate<Self> ⓘwhere
    Self: Sized,

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

1.0.0Source

fn peekable(self) -> Peekable<Self> ⓘwhere
    Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more

1.0.0Source

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> ⓘwhere
    Self: Sized,
    P: FnMut(&Self::Item) -> bool,

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

1.0.0Source

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> ⓘwhere
    Self: Sized,
    P: FnMut(&Self::Item) -> bool,

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

1.57.0Source

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P> ⓘwhere
    Self: Sized,
    P: FnMut(Self::Item) -> Option<B>,

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

1.0.0Source

fn skip(self, n: usize) -> Skip<Self> ⓘwhere
    Self: Sized,

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

1.0.0Source

fn take(self, n: usize) -> Take<Self> ⓘwhere
    Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner. Read more

1.0.0Source

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

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator. Read more

1.0.0Source

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> ⓘwhere
    Self: Sized,
    U: IntoIterator,
    F: FnMut(Self::Item) -> U,

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

1.29.0Source

fn flatten(self) -> Flatten<Self> ⓘwhere
    Self: Sized,
    Self::Item: IntoIterator,

Creates an iterator that flattens nested structure. Read more

Source

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N> ⓘwhere
    Self: Sized,
    F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows #87155)

Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well. Read more

1.0.0Source

fn fuse(self) -> Fuse<Self> ⓘwhere
    Self: Sized,

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

1.0.0Source

fn inspect<F>(self, f: F) -> Inspect<Self, F> ⓘwhere
    Self: Sized,
    F: FnMut(&Self::Item),

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

1.0.0Source

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adapter for this instance of Iterator. Read more

1.0.0Source

fn collect<B>(self) -> Bwhere
    B: FromIterator<Self::Item>,
    Self: Sized,

Transforms an iterator into a collection. Read more

Source

fn try_collect<B>(
    &mut self,
) -> <<Self::Item as Try>::Residual as Residual<B>>::TryTypewhere
    Self: Sized,
    Self::Item: Try,
    <Self::Item as Try>::Residual: Residual<B>,
    B: FromIterator<<Self::Item as Try>::Output>,

🔬This is a nightly-only experimental API. (iterator_try_collect #94047)

Fallibly transforms an iterator into a collection, short circuiting if a failure is encountered. Read more

Source

fn collect_into<E>(self, collection: &mut E) -> &mut Ewhere
    E: Extend<Self::Item>,
    Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into #94780)

Collects all the items from an iterator into a collection. Read more

1.0.0Source

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

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

Source

fn partition_in_place<'a, T, P>(self, predicate: P) -> usizewhere
    T: 'a,
    Self: Sized + DoubleEndedIterator<Item = &'a mut T>,
    P: FnMut(&T) -> bool,

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

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

Source

fn is_partitioned<P>(self, predicate: P) -> boolwhere
    Self: Sized,
    P: FnMut(Self::Item) -> bool,

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

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

1.27.0Source

fn try_for_each<F, R>(&mut self, f: F) -> Rwhere
    Self: Sized,
    F: FnMut(Self::Item) -> R,
    R: Try<Output = ()>,

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

1.51.0Source

fn reduce<F>(self, f: F) -> Option<Self::Item>where
    Self: Sized,
    F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more

Source

fn try_reduce<R>(
    &mut self,
    f: impl FnMut(Self::Item, Self::Item) -> R,
) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryTypewhere
    Self: Sized,
    R: Try<Output = Self::Item>,
    <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce #87053)

Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more

1.0.0Source

fn all<F>(&mut self, f: F) -> boolwhere
    Self: Sized,
    F: FnMut(Self::Item) -> bool,

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

1.0.0Source

fn any<F>(&mut self, f: F) -> boolwhere
    Self: Sized,
    F: FnMut(Self::Item) -> bool,

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

1.0.0Source

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

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

1.30.0Source

fn find_map<B, F>(&mut self, f: F) -> Option<B>where
    Self: Sized,
    F: FnMut(Self::Item) -> Option<B>,

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

Source

fn try_find<R>(
    &mut self,
    f: impl FnMut(&Self::Item) -> R,
) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryTypewhere
    Self: Sized,
    R: Try<Output = bool>,
    <R as Try>::Residual: Residual<Option<Self::Item>>,

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

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

1.0.0Source

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

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

1.0.0Source

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

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

1.6.0Source

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

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

1.15.0Source

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

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

1.6.0Source

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

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

1.15.0Source

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

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

1.0.0Source

fn rev(self) -> Rev<Self> ⓘwhere
    Self: Sized + DoubleEndedIterator,

Reverses an iterator’s direction. Read more

1.0.0Source

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

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

1.36.0Source

fn copied<'a, T>(self) -> Copied<Self> ⓘwhere
    T: Copy + 'a,
    Self: Sized + Iterator<Item = &'a T>,

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

1.0.0Source

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

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

1.0.0Source

fn cycle(self) -> Cycle<Self> ⓘwhere
    Self: Sized + Clone,

Repeats an iterator endlessly. Read more

Source

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N> ⓘwhere
    Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks #100450)

Returns an iterator over N elements of the iterator at a time. Read more

1.11.0Source

fn sum<S>(self) -> Swhere
    Self: Sized,
    S: Sum<Self::Item>,

Sums the elements of an iterator. Read more

1.11.0Source

fn product<P>(self) -> Pwhere
    Self: Sized,
    P: Product<Self::Item>,

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

1.5.0Source

fn cmp<I>(self, other: I) -> Orderingwhere
    I: IntoIterator<Item = Self::Item>,
    Self::Item: Ord,
    Self: Sized,

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

Source

fn cmp_by<I, F>(self, other: I, cmp: F) -> Orderingwhere
    Self: Sized,
    I: IntoIterator,
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬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

1.5.0Source

fn partial_cmp<I>(self, other: I) -> Option<Ordering>where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>,
    Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned. Read more

Source

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>where
    Self: Sized,
    I: IntoIterator,
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬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

1.5.0Source

fn eq<I>(self, other: I) -> boolwhere
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>,
    Self: Sized,

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

Source

fn eq_by<I, F>(self, other: I, eq: F) -> boolwhere
    Self: Sized,
    I: IntoIterator,
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬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

1.5.0Source

fn ne<I>(self, other: I) -> boolwhere
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>,
    Self: Sized,

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

1.5.0Source

fn lt<I>(self, other: I) -> boolwhere
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>,
    Self: Sized,

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

1.5.0Source

fn le<I>(self, other: I) -> boolwhere
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>,
    Self: Sized,

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

1.5.0Source

fn gt<I>(self, other: I) -> boolwhere
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>,
    Self: Sized,

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

1.5.0Source

fn ge<I>(self, other: I) -> boolwhere
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>,
    Self: Sized,

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

1.82.0Source

fn is_sorted_by<F>(self, compare: F) -> boolwhere
    Self: Sized,
    F: FnMut(&Self::Item, &Self::Item) -> bool,

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

1.82.0Source

fn is_sorted_by_key<F, K>(self, f: F) -> boolwhere
    Self: Sized,
    F: FnMut(Self::Item) -> K,
    K: PartialOrd,

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

1.26.0 (const: unstable)Source

impl<Idx> PartialEq for RangeInclusive<Idx>where
    Idx: PartialEq,

Source

fn eq(&self, other: &RangeInclusive<Idx>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0Source

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

1.28.0 (const: unstable)Source

impl<T> RangeBounds<T> for RangeInclusive<&T>If you need to use this implementation where T is unsized,
consider using the RangeBounds impl for a 2-tuple of Bound<&T>,
i.e. replace start..=end with (Bound::Included(start), Bound::Included(end)).

Source

fn start_bound(&self) -> Bound<&T>

Start index bound. Read more

Source

fn end_bound(&self) -> Bound<&T>

End index bound. Read more

1.35.0Source

fn contains<U>(&self, item: &U) -> boolwhere
    T: PartialOrd<U>,
    U: PartialOrd<T> + ?Sized,

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

Source

fn is_empty(&self) -> boolwhere
    T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty #137300)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false. Read more

1.28.0 (const: unstable)Source

impl<T> RangeBounds<T> for RangeInclusive<T>

Source

fn start_bound(&self) -> Bound<&T>

Start index bound. Read more

Source

fn end_bound(&self) -> Bound<&T>

End index bound. Read more

1.35.0Source

fn contains<U>(&self, item: &U) -> boolwhere
    T: PartialOrd<U>,
    U: PartialOrd<T> + ?Sized,

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

Source

fn is_empty(&self) -> boolwhere
    T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty #137300)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false. Read more

1.26.0 (const: unstable)Source

impl<T> SliceIndex<[T]> for RangeInclusive<usize>The methods index and index_mut panic if:

the end of the range is usize::MAX or
the start of the range is greater than the end of the range or
the end of the range is out of bounds.

Source

type Output = [T]

The output type returned by methods.

Source

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

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

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

Source

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

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

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

Source

unsafe fn get_unchecked(self, slice: *const [T]) -> *const [T]

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

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

Source

unsafe fn get_unchecked_mut(self, slice: *mut [T]) -> *mut [T]

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

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

Source

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

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

Source

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

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

Source

impl SliceIndex<ByteStr> for RangeInclusive<usize>

Source

type Output = ByteStr

The output type returned by methods.

Source

fn get(
    self,
    slice: &ByteStr,
) -> Option<&<RangeInclusive<usize> as SliceIndex<ByteStr>>::Output>

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

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

Source

fn get_mut(
    self,
    slice: &mut ByteStr,
) -> Option<&mut <RangeInclusive<usize> as SliceIndex<ByteStr>>::Output>

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

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

Source

unsafe fn get_unchecked(
    self,
    slice: *const ByteStr,
) -> *const <RangeInclusive<usize> as SliceIndex<ByteStr>>::Output

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

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

Source

unsafe fn get_unchecked_mut(
    self,
    slice: *mut ByteStr,
) -> *mut <RangeInclusive<usize> as SliceIndex<ByteStr>>::Output

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

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

Source

fn index(
    self,
    slice: &ByteStr,
) -> &<RangeInclusive<usize> as SliceIndex<ByteStr>>::Output ⓘ

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

Source

fn index_mut(
    self,
    slice: &mut ByteStr,
) -> &mut <RangeInclusive<usize> as SliceIndex<ByteStr>>::Output ⓘ

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

1.26.0 (const: unstable)Source

impl SliceIndex<str> for RangeInclusive<usize>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.

Source

type Output = str

The output type returned by methods.

Source

fn get(
    self,
    slice: &str,
) -> Option<&<RangeInclusive<usize> as SliceIndex<str>>::Output>

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

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

Source

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

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

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

Source

unsafe fn get_unchecked(
    self,
    slice: *const str,
) -> *const <RangeInclusive<usize> as SliceIndex<str>>::Output

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

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

Source

unsafe fn get_unchecked_mut(
    self,
    slice: *mut str,
) -> *mut <RangeInclusive<usize> as SliceIndex<str>>::Output

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

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

Source

fn index(
    self,
    slice: &str,
) -> &<RangeInclusive<usize> as SliceIndex<str>>::Output ⓘ

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

Source

fn index_mut(
    self,
    slice: &mut str,
) -> &mut <RangeInclusive<usize> as SliceIndex<str>>::Output ⓘ

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

1.26.0 (const: unstable)Source

impl<Idx> Eq for RangeInclusive<Idx>where
    Idx: Eq,

1.26.0Source

impl<A> FusedIterator for RangeInclusive<A>where
    A: Step,

1.26.0Source

impl<Idx> StructuralPartialEq for RangeInclusive<Idx>

Source

impl<A> TrustedLen for RangeInclusive<A>where
    A: TrustedStep,

Auto Trait Implementations

impl<Idx> Freeze for RangeInclusive<Idx>where
    Idx: Freeze,

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

Source

impl<T> Any for Twhere
    T: 'static + ?Sized,

Source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source

impl<T> Borrow<T> for Twhere
    T: ?Sized,

Source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

Source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source

impl<T> CloneToUninit for Twhere
    T: Clone,

Source

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)

Performs copy-assignment from self to dest. Read more

Source

impl<T> From<T> for T

Source

fn from(t: T) -> T

Returns the argument unchanged.

Source

impl<T, U> Into<U> for Twhere
    U: From<T>,

Source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source

impl<I> IntoIterator for Iwhere
    I: Iterator,

Source

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

Source

type IntoIter = I

Which kind of iterator are we turning this into?

Source

fn into_iter(self) -> I

Creates an iterator from a value. Read more

Source

impl<T> ToOwned for Twhere
    T: Clone,

Source

type Owned = T

The resulting type after obtaining ownership.

Source

fn to_owned(&self) -> T

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

Source

fn clone_into(&self, target: &mut T)

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

Source

impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

Source

type Error = Infallible

The type returned in the event of a conversion error.

Source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

Source

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

Source

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

The type returned in the event of a conversion error.

Source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

© 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/range/legacy/struct.RangeInclusive.html