Struct core::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, 4];
assert_eq!(arr[ ..  ], [0,1,2,3,4]);
assert_eq!(arr[ .. 3], [0,1,2    ]);
assert_eq!(arr[ ..=3], [0,1,2,3  ]);  // RangeToInclusive
assert_eq!(arr[1..  ], [  1,2,3,4]);
assert_eq!(arr[1.. 3], [  1,2    ]);
assert_eq!(arr[1..=3], [  1,2,3  ]);

Fields

end: Idx

The upper bound of the range (inclusive)

Methods

impl<Idx: PartialOrd<Idx>> RangeToInclusive<Idx>

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

Returns true if item is contained in the range.

Examples

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: Copy> Copy for RangeToInclusive<Idx>

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: ?Sized>(&self, item: &U) -> bool where
    T: PartialOrd<U>,
    U: PartialOrd<T>, 

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: ?Sized>(&self, item: &U) -> bool where
    T: PartialOrd<U>,
    U: PartialOrd<T>, 

Returns true if item is contained in the range.

impl<Idx: PartialEq> PartialEq<RangeToInclusive<Idx>> for RangeToInclusive<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<Idx: Eq> Eq for RangeToInclusive<Idx>

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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 #0)

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 #0)

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

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

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

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. [undefined behavior]: ../../reference/behavior-considered-undefined.html

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

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

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. [undefined behavior]: ../../reference/behavior-considered-undefined.html

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

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

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

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

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

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

impl SliceIndex<str> for RangeToInclusive<usize>

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

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

This operation is O(1).

Panics

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

type Output = str

The output type returned by methods.

fn get(self, slice: &str) -> Option<&Self::Output>

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

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

fn get_mut(self, slice: &mut str) -> Option<&mut Self::Output>

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

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

unsafe fn get_unchecked(self, slice: &str) -> &Self::Output

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

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. [undefined behavior]: ../../reference/behavior-considered-undefined.html

unsafe fn get_unchecked_mut(self, slice: &mut str) -> &mut Self::Output

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

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. [undefined behavior]: ../../reference/behavior-considered-undefined.html

fn index(self, slice: &str) -> &Self::Output

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

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

fn index_mut(self, slice: &mut str) -> &mut Self::Output

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

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

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

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

Feeds this value into the given [Hasher].

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

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

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

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

Formats the value using the given formatter.