W3cubDocs

/Rust

Struct std::ops::RangeToInclusive

#[lang = "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:

ⓘThis example deliberately fails to 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)

Implementations

impl<Idx> RangeToInclusive<Idx> where
    Idx: PartialOrd<Idx>, 
[src]

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

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<Idx> Clone for RangeToInclusive<Idx> where
    Idx: Clone
[src]

impl<Idx> Copy for RangeToInclusive<Idx> where
    Idx: Copy
[src]

impl<Idx> Debug for RangeToInclusive<Idx> where
    Idx: Debug
[src]

impl<Idx> Eq for RangeToInclusive<Idx> where
    Idx: Eq
[src]

impl<Idx> Hash for RangeToInclusive<Idx> where
    Idx: Hash
[src]

impl Index<RangeToInclusive<usize>> for String[src]

type Output = str

The returned type after indexing.

impl IndexMut<RangeToInclusive<usize>> for String[src]

impl<Idx> PartialEq<RangeToInclusive<Idx>> for RangeToInclusive<Idx> where
    Idx: PartialEq<Idx>, 
[src]

impl<T> RangeBounds<T> for RangeToInclusive<T>[src]1.28.0

impl<'_, T> RangeBounds<T> for RangeToInclusive<&'_ T>[src]1.28.0

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

type Output = [T]

The output type returned by methods.

impl SliceIndex<str> for RangeToInclusive<usize>[src]

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.

impl<Idx> StructuralEq for RangeToInclusive<Idx>[src]

impl<Idx> StructuralPartialEq for RangeToInclusive<Idx>[src]

Auto Trait Implementations

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

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/ops/struct.RangeToInclusive.html