Struct std::ops::RangeToInclusive

pub struct RangeToInclusive<Idx> {
    pub end: Idx,
}

A range only bounded inclusively above (..=end).

The RangeToInclusive ..=end contains all values with x <= end. It cannot serve as an Iterator because it doesn't have a starting point.

Examples

The ..=end syntax is a RangeToInclusive:

assert_eq!((..=5), std::ops::RangeToInclusive{ end: 5 });

It does not have an IntoIterator implementation, so you can't use it in a for loop directly. This won't compile:

// error[E0277]: the trait bound `std::ops::RangeToInclusive<{integer}>:
// std::iter::Iterator` is not satisfied
for i in ..=5 {
    // ...
}

When used as a slicing index, RangeToInclusive produces a slice of all array elements up to and including the index indicated by end.

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

Fields

end: Idx

The upper bound of the range (inclusive)

Methods

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

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

🔬 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!( (..=5).contains(&-1_000_000_000));
assert!( (..=5).contains(&5));
assert!(!(..=5).contains(&6));

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

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'a, T> RangeBounds<T> for RangeToInclusive<&'a T>

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

Start index bound.

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

End index bound.

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

🔬 This is a nightly-only experimental API. (range_contains #32311)

recently added as per RFC

Returns true if item is contained in the range.

impl<T> RangeBounds<T> for RangeToInclusive<T>

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

Start index bound.

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

End index bound.

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

🔬 This is a nightly-only experimental API. (range_contains #32311)

recently added as per RFC

Returns true if item is contained in the range.

impl<Idx> Copy for RangeToInclusive<Idx> where     Idx: Copy,

impl IndexMut<RangeToInclusive<usize>> for str

fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut str

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

impl Index<RangeToInclusive<usize>> for str

type Output = str

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &str

Performs the indexing (container[index]) operation.

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

fn clone(&self) -> RangeToInclusive<Idx>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

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

fn ne(&self, other: &RangeToInclusive<Idx>) -> bool

This method tests for !=.

impl SliceIndex<str> for RangeToInclusive<usize>

type Output = str

The output type returned by methods.

fn get(     self,     slice: &str ) -> Option<&<RangeToInclusive<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.

fn get_mut(     self,     slice: &mut str ) -> Option<&mut <RangeToInclusive<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.

unsafe fn get_unchecked(     self,     slice: &str ) -> &<RangeToInclusive<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, without performing any bounds checking.

unsafe fn get_unchecked_mut(     self,     slice: &mut str ) -> &mut <RangeToInclusive<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, without performing any bounds checking.

fn index(     self,     slice: &str ) -> &<RangeToInclusive<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.

fn index_mut(     self,     slice: &mut str ) -> &mut <RangeToInclusive<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.

impl<T> SliceIndex<[T]> for RangeToInclusive<usize>

type Output = [T]

The output type returned by methods.

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.

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.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

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

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

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

unsafe fn get_unchecked_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, without performing any bounds checking.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

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.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

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.

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

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

Feeds this value into the given [Hasher].

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

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

impl Index<RangeToInclusive<usize>> for String

type Output = str

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &str

Performs the indexing (container[index]) operation.

impl IndexMut<RangeToInclusive<usize>> for String

fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut str

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