core::ops::RangeToInclusive - Rust
Description: API documentation for the Rust `RangeToInclusive` struct in crate `core`.
Keywords: rust, rustlang, rust-lang, RangeToInclusive

# Struct core::ops::RangeToInclusive [−] [src]

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

🔬 This is a nightly-only experimental API. (`inclusive_range` #28237)

recently added, follows RFC

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`:

    #![feature(inclusive_range,inclusive_range_syntax)]
    assert_eq!((..=5), std::ops::RangeToInclusive{ end: 5 });Run

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

⚠This code doesn't compile so be extra careful!

    #![feature(inclusive_range_syntax)]

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

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

    #![feature(inclusive_range_syntax)]

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

## Fields

`end: Idx`
🔬 This is a nightly-only experimental API. (`inclusive_range` #28237)

recently added, follows RFC

The upper bound of the range (inclusive)

## Methods

### `impl<Idx: PartialOrd<Idx>> RangeToInclusive<Idx>`
[src]

#### `pub fn contains(&self, item: Idx) -> bool`
[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,inclusive_range_syntax)]

    assert!( (..=5).contains(-1_000_000_000));
    assert!( (..=5).contains(5));
    assert!(!(..=5).contains(6));Run

## Trait Implementations

### `impl<Idx: Copy> Copy for RangeToInclusive<Idx>`
[src]

### `impl<Idx: Clone> Clone for RangeToInclusive<Idx>`
[src]

#### `fn clone(&self) -> RangeToInclusive<Idx>`
[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from `source`. Read more

### `impl<Idx: PartialEq> PartialEq for RangeToInclusive<Idx>`
[src]

#### `fn eq(&self, __arg_0: &RangeToInclusive<Idx>) -> bool`
[src]

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

#### `fn ne(&self, __arg_0: &RangeToInclusive<Idx>) -> bool`
[src]

This method tests for `!=`.

### `impl<Idx: Eq> Eq for RangeToInclusive<Idx>`
[src]

### `impl<Idx: Hash> Hash for RangeToInclusive<Idx>`
[src]

#### `fn hash<__HIdx: Hasher>(&self, __arg_0: &mut __HIdx)`
[src]

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

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

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

### `impl<Idx: Debug> Debug for RangeToInclusive<Idx>`
[src]

#### `fn fmt(&self, fmt: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter.

### `impl<T> SliceIndex<[T]> for RangeToInclusive<usize>`
[src]

#### `type Output = [T]`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

The output type returned by methods.

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

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

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

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

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

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

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

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

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

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

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

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

### `impl SliceIndex<str> for RangeToInclusive<usize>`
1.20.0
[src]

#### `type Output = str`

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

The output type returned by methods.

#### `fn get(self, slice: &str) -> Option<&Self::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

#### `fn get_mut(self, slice: &mut str) -> Option<&mut Self::Output>`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

#### `unsafe fn get_unchecked(self, slice: &str) -> &Self::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

#### `unsafe fn get_unchecked_mut(self, slice: &mut str) -> &mut Self::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

#### `fn index(self, slice: &str) -> &Self::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

#### `fn index_mut(self, slice: &mut str) -> &mut Self::Output`
[src]

🔬 This is a nightly-only experimental API. (`slice_get_slice` #35729)

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

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)