W3cubDocs

/Rust

Struct RangeToInclusive

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

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

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

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

Examples

The ..=last syntax is a RangeToInclusive:

#![feature(new_range_api)]
#![feature(new_range)]
assert_eq!((..=5), std::range::RangeToInclusive{ last: 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::range::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 last.

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

last: Idx

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

The upper bound of the range (inclusive)

Implementations

Source

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

Source

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

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

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

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.0Source

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

Performs copy-assignment from source. Read more

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.

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

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