Struct 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   ]); // 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

impl<Idx> RangeToInclusive<Idx>

where Idx: PartialOrd,

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

impl<T> Archive for RangeToInclusive<T>

where T: Archive,

type Archived = ArchivedRangeToInclusive<<T as Archive>::Archived>

The archived representation of this type.

type Resolver = RangeToInclusive<<T as Archive>::Resolver>

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

unsafe fn resolve( &self, pos: usize, resolver: <RangeToInclusive<T> as Archive>::Resolver, out: *mut <RangeToInclusive<T> as Archive>::Archived, )

Creates the archived version of this value at the given position and writes it to the given output.

impl<Idx> Clone for RangeToInclusive<Idx>

where Idx: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C1, C2> ContainsToken<C1> for RangeToInclusive<C2>

where C1: AsChar, C2: AsChar + Clone,

fn contains_token(&self, token: C1) -> bool

Returns true if self contains the token

impl<C1, C2> ContainsToken<C1> for RangeToInclusive<C2>

where C1: AsChar, C2: AsChar + Clone,

fn contains_token(&self, token: C1) -> bool

Returns true if self contains the token

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<T, D> Deserialize<RangeToInclusive<T>, D> for <RangeToInclusive<T> as Archive>::Archived

where T: Archive, <T as Archive>::Archived: Deserialize<T, D>, D: Fallible + ?Sized,

fn deserialize( &self, deserializer: &mut D, ) -> Result<RangeToInclusive<T>, <D as Fallible>::Error>

Deserializes using the given deserializer

impl From<RangeToInclusive<usize>> for Range

fn from(range: RangeToInclusive<usize>) -> Range

Converts to this type from the input type.

impl From<RangeToInclusive<usize>> for Range

fn from(range: RangeToInclusive<usize>) -> Range

Converts to this type from the input type.

impl<Idx> Hash for RangeToInclusive<Idx>

where Idx: Hash,

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<RangeToInclusive<usize>> for ArchivedString

type Output = str

The returned type after indexing.

fn index( &self, index: RangeToInclusive<usize>, ) -> &<ArchivedString as Index<RangeToInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for BStr

type Output = BStr

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for BStr

type Output = BStr

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for ByteString

type Output = ByteStr

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for Bytes

type Output = Bytes

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for Bytes

type Output = Bytes

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<K, V, S> Index<RangeToInclusive<usize>> for IndexMap<K, V, S>

type Output = Slice<K, V>

The returned type after indexing.

fn index( &self, range: RangeToInclusive<usize>, ) -> &<IndexMap<K, V, S> as Index<RangeToInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl<T, S> Index<RangeToInclusive<usize>> for IndexSet<T, S>

type Output = Slice<T>

The returned type after indexing.

fn index( &self, range: RangeToInclusive<usize>, ) -> &<IndexSet<T, S> as Index<RangeToInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl<K, V> Index<RangeToInclusive<usize>> for Slice<K, V>

type Output = Slice<K, V>

The returned type after indexing.

fn index(&self, range: RangeToInclusive<usize>) -> &Slice<K, V>

Performs the indexing (container[index]) operation.

impl<T> Index<RangeToInclusive<usize>> for Slice<T>

type Output = Slice<T>

The returned type after indexing.

fn index( &self, range: RangeToInclusive<usize>, ) -> &<Slice<T> as Index<RangeToInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for UninitSlice

type Output = UninitSlice

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<RangeToInclusive<usize>> for ByteString

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

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

impl<K, V, S> IndexMut<RangeToInclusive<usize>> for IndexMap<K, V, S>

fn index_mut( &mut self, range: RangeToInclusive<usize>, ) -> &mut <IndexMap<K, V, S> as Index<RangeToInclusive<usize>>>::Output

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

impl<K, V> IndexMut<RangeToInclusive<usize>> for Slice<K, V>

fn index_mut(&mut self, range: RangeToInclusive<usize>) -> &mut Slice<K, V>

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

impl IndexMut<RangeToInclusive<usize>> for UninitSlice

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

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

impl<T> IntoBounds<T> for RangeToInclusive<T>

fn into_bounds(self) -> (Bound<T>, Bound<T>)

🔬This is a nightly-only experimental API. (range_into_bounds)

Convert this range into the start and end bounds. Returns (start_bound, end_bound).

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)

Compute the intersection of self and other.

impl<I> IteratorIndex<I> for RangeToInclusive<usize>

where I: Iterator,

type Output = Take<I>

The type returned for this type of index.

fn index(self, iter: I) -> <RangeToInclusive<usize> as IteratorIndex<I>>::Output

Returns an adapted iterator for the current index.

impl<T> OneSidedRange<T> for RangeToInclusive<T>

where RangeToInclusive<T>: RangeBounds<T>,

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

🔬This is a nightly-only experimental API. (one_sided_range)

An internal-only helper function for split_off and split_off_mut that returns the bound of the one-sided range.

impl<T, U> PartialEq<RangeToInclusive<T>> for ArchivedRangeToInclusive<U>

where U: PartialEq<T>,

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Idx> PartialEq for RangeToInclusive<Idx>

where Idx: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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,

Returns true if item is contained in the range.

fn is_empty(&self) -> bool

where T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.

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,

Returns true if item is contained in the range.

fn is_empty(&self) -> bool

where T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.

impl SampleRange<u128> for RangeToInclusive<u128>

fn sample_single<R>(self, rng: &mut R) -> Result<u128, Error>

where R: RngCore + ?Sized,

Generate a sample from the given range.

fn is_empty(&self) -> bool

Check whether the range is empty.

impl SampleRange<u16> for RangeToInclusive<u16>

fn sample_single<R>(self, rng: &mut R) -> Result<u16, Error>

where R: RngCore + ?Sized,

Generate a sample from the given range.

fn is_empty(&self) -> bool

Check whether the range is empty.

impl SampleRange<u32> for RangeToInclusive<u32>

fn sample_single<R>(self, rng: &mut R) -> Result<u32, Error>

where R: RngCore + ?Sized,

Generate a sample from the given range.

fn is_empty(&self) -> bool

Check whether the range is empty.

impl SampleRange<u64> for RangeToInclusive<u64>

fn sample_single<R>(self, rng: &mut R) -> Result<u64, Error>

where R: RngCore + ?Sized,

Generate a sample from the given range.

fn is_empty(&self) -> bool

Check whether the range is empty.

impl SampleRange<u8> for RangeToInclusive<u8>

fn sample_single<R>(self, rng: &mut R) -> Result<u8, Error>

where R: RngCore + ?Sized,

Generate a sample from the given range.

fn is_empty(&self) -> bool

Check whether the range is empty.

impl SampleRange<usize> for RangeToInclusive<usize>

fn sample_single<R>(self, rng: &mut R) -> Result<usize, Error>

where R: RngCore + ?Sized,

Generate a sample from the given range.

fn is_empty(&self) -> bool

Check whether the range is empty.

impl<T, S> Serialize<S> for RangeToInclusive<T>

where T: Serialize<S>, S: Fallible + ?Sized,

fn serialize( &self, serializer: &mut S, ) -> Result<<RangeToInclusive<T> as Archive>::Resolver, <S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

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

The methods index and index_mut panic if the end of the range is out of bounds.

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.

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.

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.

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.

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 SliceIndex<ByteStr> for RangeToInclusive<usize>

type Output = ByteStr

The output type returned by methods.

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.

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.

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.

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.

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.

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.

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<&<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: *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.

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.

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

where Idx: Copy,

impl<Idx> Eq for RangeToInclusive<Idx>

where Idx: Eq,

impl<Idx> StructuralPartialEq for RangeToInclusive<Idx>