W3cubDocs

/Rust

Struct RangeFrom 

pub struct RangeFrom<Idx> {
    pub start: Idx,
}
🔬This is a nightly-only experimental API. (new_range_api #125687)

A range only bounded inclusively below (start..).

The RangeFrom start.. contains all values with x >= start.

Note: Overflow in the Iterator implementation (when the contained data type reaches its numerical limit) is allowed to panic, wrap, or saturate. This behavior is defined by the implementation of the Step trait. For primitive integers, this follows the normal rules, and respects the overflow checks profile (panic in debug, wrap in release). Note also that overflow happens earlier than you might assume: the overflow happens in the call to next that yields the maximum value, as the range must be set to a state to yield the next value.

Examples

The start.. syntax is a RangeFrom:

#![feature(new_range_api)]
use core::range::RangeFrom;

assert_eq!(RangeFrom::from(2..), core::range::RangeFrom { start: 2 });
assert_eq!(2 + 3 + 4, RangeFrom::from(2..).into_iter().take(3).sum());

Fields

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

The lower bound of the range (inclusive).

Implementations

Source
impl<Idx> RangeFrom<Idx>where
    Idx: Step,
Source
pub fn iter(&self) -> RangeFromIter<Idx> ⓘ
🔬This is a nightly-only experimental API. (new_range_api #125687)

Creates an iterator over the elements within this range.

Shorthand for .clone().into_iter()

Examples
#![feature(new_range_api)]
use core::range::RangeFrom;

let mut i = RangeFrom::from(3..).iter().map(|n| n*n);
assert_eq!(i.next(), Some(9));
assert_eq!(i.next(), Some(16));
assert_eq!(i.next(), Some(25));
Source
impl<Idx> RangeFrom<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
#![feature(new_range_api)]
use core::range::RangeFrom;

assert!(!RangeFrom::from(3..).contains(&2));
assert!( RangeFrom::from(3..).contains(&3));
assert!( RangeFrom::from(3..).contains(&1_000_000_000));

assert!( RangeFrom::from(0.0..).contains(&0.5));
assert!(!RangeFrom::from(0.0..).contains(&f32::NAN));
assert!(!RangeFrom::from(f32::NAN..).contains(&0.5));

Trait Implementations

Source
impl<Idx> Clone for RangeFrom<Idx>where
    Idx: Clone,
Source
fn clone(&self) -> RangeFrom<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 RangeFrom<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<RangeFrom<T>> for RangeFrom<T>
Source
fn from(value: RangeFrom<T>) -> RangeFrom<T> ⓘ
Converts to this type from the input type.
Source
impl<T> From<RangeFrom<T>> for RangeFrom<T>
Source
fn from(value: RangeFrom<T>) -> RangeFrom<T>
Converts to this type from the input type.
Source
impl<Idx> Hash for RangeFrom<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 RangeFrom<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<A> IntoIterator for RangeFrom<A>where
    A: Step,
Source
type Item = A
The type of the elements being iterated over.
Source
type IntoIter = RangeFromIter<A>
Which kind of iterator are we turning this into?
Source
fn into_iter(self) -> <RangeFrom<A> as IntoIterator>::IntoIter
Creates an iterator from a value. Read more
Source
impl<Idx> PartialEq for RangeFrom<Idx>where
    Idx: PartialEq,
Source
fn eq(&self, other: &RangeFrom<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 RangeFrom<&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 start.. with (Bound::Included(start), Bound::Unbounded).
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
Source
impl<T> RangeBounds<T> for RangeFrom<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
Source
impl<T> SliceIndex<[T]> for RangeFrom<usize>
Source
type Output = [T]
The output type returned by methods.
Source
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]>
🔬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]
🔬This is a nightly-only experimental API. (slice_index_methods)
Returns a pointer to the output at this location, without performing any bounds checking. Read more
Source
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. Read more
Source
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.
Source
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.
Source
impl SliceIndex<ByteStr> for RangeFrom<usize>
Source
type Output = ByteStr
The output type returned by methods.
Source
fn get(
    self,
    slice: &ByteStr,
) -> Option<&<RangeFrom<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.
Source
fn get_mut(
    self,
    slice: &mut ByteStr,
) -> Option<&mut <RangeFrom<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.
Source
unsafe fn get_unchecked(
    self,
    slice: *const ByteStr,
) -> *const <RangeFrom<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. Read more
Source
unsafe fn get_unchecked_mut(
    self,
    slice: *mut ByteStr,
) -> *mut <RangeFrom<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. Read more
Source
fn index(
    self,
    slice: &ByteStr,
) -> &<RangeFrom<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.
Source
fn index_mut(
    self,
    slice: &mut ByteStr,
) -> &mut <RangeFrom<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.
Source
impl SliceIndex<str> for RangeFrom<usize>
Source
type Output = str
The output type returned by methods.
Source
fn get(
    self,
    slice: &str,
) -> Option<&<RangeFrom<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.
Source
fn get_mut(
    self,
    slice: &mut str,
) -> Option<&mut <RangeFrom<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.
Source
unsafe fn get_unchecked(
    self,
    slice: *const str,
) -> *const <RangeFrom<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. Read more
Source
unsafe fn get_unchecked_mut(
    self,
    slice: *mut str,
) -> *mut <RangeFrom<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. Read more
Source
fn index(self, slice: &str) -> &<RangeFrom<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.
Source
fn index_mut(
    self,
    slice: &mut str,
) -> &mut <RangeFrom<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.
Source
impl<Idx> Copy for RangeFrom<Idx>where
    Idx: Copy,
Source
impl<Idx> Eq for RangeFrom<Idx>where
    Idx: Eq,
Source
impl<Idx> StructuralPartialEq for RangeFrom<Idx>

Auto Trait Implementations

impl<Idx> Freeze for RangeFrom<Idx>where
    Idx: Freeze,
impl<Idx> RefUnwindSafe for RangeFrom<Idx>where
    Idx: RefUnwindSafe,
impl<Idx> Send for RangeFrom<Idx>where
    Idx: Send,
impl<Idx> Sync for RangeFrom<Idx>where
    Idx: Sync,
impl<Idx> Unpin for RangeFrom<Idx>where
    Idx: Unpin,
impl<Idx> UnwindSafe for RangeFrom<Idx>where
    Idx: UnwindSafe,

Blanket Implementations

Source
impl<T> Any for Twhere
    T: 'static + ?Sized,
Source
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
Source
impl<T> Borrow<T> for Twhere
    T: ?Sized,
Source
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
Source
impl<T> BorrowMut<T> for Twhere
    T: ?Sized,
Source
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source
impl<T> CloneToUninit for Twhere
    T: Clone,
Source
unsafe fn clone_to_uninit(&self, dest: *mut u8)
🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dest. Read more
Source
impl<T> From<T> for T
Source
fn from(t: T) -> T

Returns the argument unchanged.

Source
impl<T, U> Into<U> for Twhere
    U: From<T>,
Source
fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source
impl<T> ToOwned for Twhere
    T: Clone,
Source
type Owned = T
The resulting type after obtaining ownership.
Source
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
Source
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more
Source
impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,
Source
type Error = Infallible
The type returned in the event of a conversion error.
Source
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
Source
impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,
Source
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
Source
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.

© 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/range/struct.RangeFrom.html