Struct core::range::RangeInclusive
source · pub struct RangeInclusive<Idx> {
pub start: Idx,
pub end: Idx,
}
🔬This is a nightly-only experimental API. (
new_range_api
#125687)Expand description
A range bounded inclusively below and above (start..=end
).
The RangeInclusive
start..=end
contains all values with x >= start
and x <= end
. It is empty unless start <= end
.
§Examples
The start..=end
syntax is a RangeInclusive
:
#![feature(new_range_api)]
use core::range::RangeInclusive;
assert_eq!(RangeInclusive::from(3..=5), RangeInclusive { start: 3, end: 5 });
assert_eq!(3 + 4 + 5, RangeInclusive::from(3..=5).into_iter().sum());
RunFields§
§start: Idx
🔬This is a nightly-only experimental API. (
new_range_api
#125687)The lower bound of the range (inclusive).
end: Idx
🔬This is a nightly-only experimental API. (
new_range_api
#125687)The upper bound of the range (inclusive).
Implementations§
source§impl<Idx: PartialOrd<Idx>> RangeInclusive<Idx>
impl<Idx: PartialOrd<Idx>> RangeInclusive<Idx>
sourcepub fn contains<U>(&self, item: &U) -> bool
🔬This is a nightly-only experimental API. (new_range_api
#125687)
pub fn contains<U>(&self, item: &U) -> bool
new_range_api
#125687)Returns true
if item
is contained in the range.
§Examples
#![feature(new_range_api)]
use core::range::RangeInclusive;
assert!(!RangeInclusive::from(3..=5).contains(&2));
assert!( RangeInclusive::from(3..=5).contains(&3));
assert!( RangeInclusive::from(3..=5).contains(&4));
assert!( RangeInclusive::from(3..=5).contains(&5));
assert!(!RangeInclusive::from(3..=5).contains(&6));
assert!( RangeInclusive::from(3..=3).contains(&3));
assert!(!RangeInclusive::from(3..=2).contains(&3));
assert!( RangeInclusive::from(0.0..=1.0).contains(&1.0));
assert!(!RangeInclusive::from(0.0..=1.0).contains(&f32::NAN));
assert!(!RangeInclusive::from(0.0..=f32::NAN).contains(&0.0));
assert!(!RangeInclusive::from(f32::NAN..=1.0).contains(&1.0));
Runsourcepub fn is_empty(&self) -> bool
🔬This is a nightly-only experimental API. (new_range_api
#125687)
pub fn is_empty(&self) -> bool
new_range_api
#125687)Returns true
if the range contains no items.
§Examples
#![feature(new_range_api)]
use core::range::RangeInclusive;
assert!(!RangeInclusive::from(3..=5).is_empty());
assert!(!RangeInclusive::from(3..=3).is_empty());
assert!( RangeInclusive::from(3..=2).is_empty());
RunThe range is empty if either side is incomparable:
#![feature(new_range_api)]
use core::range::RangeInclusive;
assert!(!RangeInclusive::from(3.0..=5.0).is_empty());
assert!( RangeInclusive::from(3.0..=f32::NAN).is_empty());
assert!( RangeInclusive::from(f32::NAN..=5.0).is_empty());
Runsource§impl<Idx: Step> RangeInclusive<Idx>
impl<Idx: Step> RangeInclusive<Idx>
sourcepub fn iter(&self) -> IterRangeInclusive<Idx> ⓘ
🔬This is a nightly-only experimental API. (new_range_api
#125687)
pub fn iter(&self) -> IterRangeInclusive<Idx> ⓘ
new_range_api
#125687)Create an iterator over the elements within this range.
Shorthand for .clone().into_iter()
§Examples
#![feature(new_range_api)]
use core::range::RangeInclusive;
let mut i = RangeInclusive::from(3..=8).iter().map(|n| n*n);
assert_eq!(i.next(), Some(9));
assert_eq!(i.next(), Some(16));
assert_eq!(i.next(), Some(25));
RunTrait Implementations§
source§impl<Idx: Clone> Clone for RangeInclusive<Idx>
impl<Idx: Clone> Clone for RangeInclusive<Idx>
source§fn clone(&self) -> RangeInclusive<Idx>
fn clone(&self) -> RangeInclusive<Idx>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<Idx: Debug> Debug for RangeInclusive<Idx>
impl<Idx: Debug> Debug for RangeInclusive<Idx>
source§impl<T> From<RangeInclusive<T>> for RangeInclusive<T>
impl<T> From<RangeInclusive<T>> for RangeInclusive<T>
source§fn from(value: RangeInclusive<T>) -> Self
fn from(value: RangeInclusive<T>) -> Self
Converts to this type from the input type.
source§impl<T> From<RangeInclusive<T>> for RangeInclusive<T>
impl<T> From<RangeInclusive<T>> for RangeInclusive<T>
source§fn from(value: RangeInclusive<T>) -> Self
fn from(value: RangeInclusive<T>) -> Self
Converts to this type from the input type.
source§impl<Idx: Hash> Hash for RangeInclusive<Idx>
impl<Idx: Hash> Hash for RangeInclusive<Idx>
source§impl<A: Step> IntoIterator for RangeInclusive<A>
impl<A: Step> IntoIterator for RangeInclusive<A>
source§impl<Idx: PartialEq> PartialEq for RangeInclusive<Idx>
impl<Idx: PartialEq> PartialEq for RangeInclusive<Idx>
source§fn eq(&self, other: &RangeInclusive<Idx>) -> bool
fn eq(&self, other: &RangeInclusive<Idx>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl<T> RangeBounds<T> for RangeInclusive<&T>
impl<T> RangeBounds<T> for RangeInclusive<&T>
source§impl<T> RangeBounds<T> for RangeInclusive<T>
impl<T> RangeBounds<T> for RangeInclusive<T>
source§impl<T> SliceIndex<[T]> for RangeInclusive<usize>
impl<T> SliceIndex<[T]> for RangeInclusive<usize>
source§fn get(self, slice: &[T]) -> Option<&[T]>
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]>
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]
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.
Calling this method with an out-of-bounds index or a dangling
slice
pointer
is undefined behavior even if the resulting pointer is not used.source§unsafe fn get_unchecked_mut(self, slice: *mut [T]) -> *mut [T]
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.
Calling this method with an out-of-bounds index or a dangling
slice
pointer
is undefined behavior even if the resulting pointer is not used.source§impl SliceIndex<str> for RangeInclusive<usize>
impl SliceIndex<str> for RangeInclusive<usize>
source§fn get(self, slice: &str) -> Option<&Self::Output>
fn get(self, slice: &str) -> Option<&Self::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 Self::Output>
fn get_mut(self, slice: &mut str) -> Option<&mut Self::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 Self::Output
unsafe fn get_unchecked(self, slice: *const str) -> *const Self::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.
Calling this method with an out-of-bounds index or a dangling
slice
pointer
is undefined behavior even if the resulting pointer is not used.source§unsafe fn get_unchecked_mut(self, slice: *mut str) -> *mut Self::Output
unsafe fn get_unchecked_mut(self, slice: *mut str) -> *mut Self::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.
Calling this method with an out-of-bounds index or a dangling
slice
pointer
is undefined behavior even if the resulting pointer is not used.impl<Idx: Copy> Copy for RangeInclusive<Idx>
impl<Idx: Eq> Eq for RangeInclusive<Idx>
impl<Idx> StructuralPartialEq for RangeInclusive<Idx>
Auto Trait Implementations§
impl<Idx> Freeze for RangeInclusive<Idx>where
Idx: Freeze,
impl<Idx> RefUnwindSafe for RangeInclusive<Idx>where
Idx: RefUnwindSafe,
impl<Idx> Send for RangeInclusive<Idx>where
Idx: Send,
impl<Idx> Sync for RangeInclusive<Idx>where
Idx: Sync,
impl<Idx> Unpin for RangeInclusive<Idx>where
Idx: Unpin,
impl<Idx> UnwindSafe for RangeInclusive<Idx>where
Idx: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more