RangeToInclusive in std::ops - Rust
Description: A range only bounded inclusively above (`..=end`).

## RangeToInclusive

# Struct RangeToInclusive

1.26.0 · Source

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

Expand description

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

## Implementations§

Source§

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

1.35.0 (const: unstable) · Source

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

Returns `true` if `item` is contained in the range.

##### §Examples

    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§

1.26.0 · Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
1.26.0 · Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl<T> From<RangeToInclusive<T>> for RangeToInclusive<T>

Source§

#### fn from(value: RangeToInclusive<T>) -> RangeToInclusive<T>

Converts to this type from the input type.
Source§

### impl<T> From<RangeToInclusive<T>> for RangeToInclusive<T>

Source§

#### fn from(value: RangeToInclusive<T>) -> RangeToInclusive<T>

Converts to this type from the input type.
1.26.0 · Source§

### impl<Idx> Hash for RangeToInclusive<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.0 · Source§

#### 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<RangeToInclusive<usize>> for ByteString

Source§

#### type Output = ByteStr

The returned type after indexing.
Source§

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

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

### impl IndexMut<RangeToInclusive<usize>> for ByteString

Source§

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

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

### impl<T> IntoBounds<T> for RangeToInclusive<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
Source§

### impl<T> OneSidedRange<T> for RangeToInclusive<T>
where RangeToInclusive<T>: RangeBounds<T>,

Source§

#### fn bound(self) -> (OneSidedRangeBound, T)

🔬This is a nightly-only experimental API. (`one_sided_range` #69780)
An internal-only helper function for `split_off` and `split_off_mut` that returns the bound of the one-sided range.
1.26.0 · Source§

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

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

#### 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 RangeToInclusive<&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 `..=end` with `(Bound::Unbounded, 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.0 · Source§

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

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

#### fn is_empty(&self) -> bool
where 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 RangeToInclusive<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.0 · Source§

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

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

#### fn is_empty(&self) -> bool
where 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 RangeToInclusive<usize>

The methods `index` and `index_mut` panic if 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 RangeToInclusive<usize>

Source§

#### type Output = ByteStr

The output type returned by methods.
Source§

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

Source§

#### type Output = str

The output type returned by methods.
Source§

#### 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.
Source§

#### 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.
Source§

#### unsafe fn get_unchecked( self, slice: *const str, ) -> *const <RangeToInclusive<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 <RangeToInclusive<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, ) -> &<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.
Source§

#### 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.
1.26.0 · Source§

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

1.26.0 · Source§

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

1.26.0 · Source§

### impl<Idx> StructuralPartialEq for RangeToInclusive<Idx>

## Auto Trait Implementations§

§

### impl<Idx> Freeze for RangeToInclusive<Idx>
where Idx: Freeze,

§

### impl<Idx> RefUnwindSafe for RangeToInclusive<Idx>
where Idx: RefUnwindSafe,

§

### impl<Idx> Send for RangeToInclusive<Idx>
where Idx: Send,

§

### impl<Idx> Sync for RangeToInclusive<Idx>
where Idx: Sync,

§

### impl<Idx> Unpin for RangeToInclusive<Idx>
where Idx: Unpin,

§

### impl<Idx> UnwindSafe for RangeToInclusive<Idx>
where Idx: UnwindSafe,

## Blanket Implementations§

Source§

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

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where 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 T
where 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<T> ToOwned for T
where 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 T
where 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 T
where 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.