Struct nom::lib::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:

// 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<Idx>, 

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

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<'a, O, T> BitSliceIndex<'a, O, T> for RangeToInclusive<usize> where
    O: 'a + BitOrder,
    T: 'a + BitStore, 

type Immut = &'a BitSlice<O, T>

The output type for immutable functions.

type Mut = &'a mut BitSlice<O, T>

The output type for mutable functions.

pub fn get(
    self,
    slice: <RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Immut
) -> Option<<RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Immut>

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

pub fn get_mut(
    self,
    slice: <RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Mut
) -> Option<<RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Mut>

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

pub unsafe fn get_unchecked(
    self,
    slice: <RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Immut
) -> <RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Immut

Returns a shared reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-bounds index is undefined behavior even if the resulting reference is not used.

pub unsafe fn get_unchecked_mut(
    self,
    slice: <RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Mut
) -> <RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Mut

Returns a mutable reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-bounds index is undefined behavior even if the resulting reference is not used.

pub fn index(
    self,
    slice: <RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Immut
) -> <RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Immut

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

pub fn index_mut(
    self,
    slice: <RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Mut
) -> <RangeToInclusive<usize> as BitSliceIndex<'a, O, T>>::Mut

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

impl<Idx> Hash for RangeToInclusive<Idx> where
    Idx: Hash, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Index<RangeToInclusive<usize>> for String

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<O, T> Index<RangeToInclusive<usize>> for BitSlice<O, T> where
    O: BitOrder,
    T: BitStore, 

type Output = BitSlice<O, T>

The returned type after indexing.

pub fn index(
    &self,
    index: RangeToInclusive<usize>
) -> &<BitSlice<O, T> as Index<RangeToInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<RangeToInclusive<usize>> for String

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

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

impl<O, T> IndexMut<RangeToInclusive<usize>> for BitSlice<O, T> where
    O: BitOrder,
    T: BitStore, 

pub fn index_mut(
    &mut self,
    index: RangeToInclusive<usize>
) -> &mut <BitSlice<O, T> as Index<RangeToInclusive<usize>>>::Output

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

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

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

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

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

This method tests for !=.

impl<'_, T> RangeBounds<T> for RangeToInclusive<&'_ T>

pub fn start_bound(&self) -> Bound<&T>

Start index bound.

pub fn end_bound(&self) -> Bound<&T>

End index bound.

pub fn assert_len(self, len: usize) -> Range<usize> where
    Self: RangeBounds<usize>, 

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

Performs bounds-checking of this range.

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

Returns true if item is contained in the range.

impl<T> RangeBounds<T> for RangeToInclusive<T>

pub fn start_bound(&self) -> Bound<&T>

Start index bound.

pub fn end_bound(&self) -> Bound<&T>

End index bound.

pub fn assert_len(self, len: usize) -> Range<usize> where
    Self: RangeBounds<usize>, 

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

Performs bounds-checking of this range.

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

Returns true if item is contained in the range.

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

type Output = [T]

The output type returned by methods.

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

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

pub unsafe fn get_unchecked(self, slice: *const [T]) -> *const [T]

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

Returns a shared reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-bounds index or a dangling slice pointer is undefined behavior even if the resulting reference is not used.

pub unsafe fn get_unchecked_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, without performing any bounds checking. Calling this method with an out-of-bounds index or a dangling slice pointer is undefined behavior even if the resulting reference is not used.

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

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

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

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

pub 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 shared reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-bounds index or a dangling slice pointer is undefined behavior even if the resulting reference is not used.

pub 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 reference to the output at this location, without performing any bounds checking. Calling this method with an out-of-bounds index or a dangling slice pointer is undefined behavior even if the resulting reference is not used.

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

pub 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> StructuralEq for RangeToInclusive<Idx>

impl<Idx> StructuralPartialEq for RangeToInclusive<Idx>