2017-06-07 21:44:03 -04:00
|
|
|
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
|
|
|
|
// file at the top-level directory of this distribution and at
|
|
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
|
|
// option. This file may not be copied, modified, or distributed
|
|
|
|
// except according to those terms.
|
|
|
|
|
|
|
|
use fmt;
|
|
|
|
|
2017-08-07 22:55:20 +02:00
|
|
|
/// An unbounded range (`..`).
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2017-08-08 14:34:37 +02:00
|
|
|
/// `RangeFull` is primarily used as a [slicing index], its shorthand is `..`.
|
2017-08-07 22:55:20 +02:00
|
|
|
/// It cannot serve as an [`Iterator`] because it doesn't have a starting point.
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// The `..` syntax is a `RangeFull`:
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// assert_eq!((..), std::ops::RangeFull);
|
|
|
|
/// ```
|
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// It does not have an [`IntoIterator`] implementation, so you can't use it in
|
|
|
|
/// a `for` loop directly. This won't compile:
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2017-06-20 15:15:16 +08:00
|
|
|
/// ```compile_fail,E0277
|
2017-06-07 21:44:03 -04:00
|
|
|
/// for i in .. {
|
|
|
|
/// // ...
|
|
|
|
/// }
|
|
|
|
/// ```
|
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// Used as a [slicing index], `RangeFull` produces the full array as a slice.
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// let arr = [0, 1, 2, 3];
|
|
|
|
/// assert_eq!(arr[ .. ], [0,1,2,3]); // RangeFull
|
|
|
|
/// assert_eq!(arr[ ..3], [0,1,2 ]);
|
|
|
|
/// assert_eq!(arr[1.. ], [ 1,2,3]);
|
|
|
|
/// assert_eq!(arr[1..3], [ 1,2 ]);
|
|
|
|
/// ```
|
2017-08-07 22:55:20 +02:00
|
|
|
///
|
|
|
|
/// [`IntoIterator`]: ../iter/trait.Iterator.html
|
|
|
|
/// [`Iterator`]: ../iter/trait.IntoIterator.html
|
|
|
|
/// [slicing index]: ../slice/trait.SliceIndex.html
|
2017-06-07 21:44:03 -04:00
|
|
|
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
pub struct RangeFull;
|
|
|
|
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
impl fmt::Debug for RangeFull {
|
|
|
|
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
write!(fmt, "..")
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-08-07 22:55:20 +02:00
|
|
|
/// A (half-open) range bounded inclusively below and exclusively above
|
|
|
|
/// (`start..end`).
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// The `Range` `start..end` contains all values with `x >= start` and
|
2018-02-10 16:32:05 -08:00
|
|
|
/// `x < end`. It is empty unless `start < end`.
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2017-08-07 22:55:20 +02:00
|
|
|
/// assert_eq!((3..5), std::ops::Range { start: 3, end: 5 });
|
|
|
|
/// assert_eq!(3 + 4 + 5, (3..6).sum());
|
|
|
|
///
|
2018-02-11 17:54:44 -08:00
|
|
|
/// let arr = ['a', 'b', 'c', 'd'];
|
|
|
|
/// assert_eq!(arr[ .. ], ['a', 'b', 'c', 'd']);
|
|
|
|
/// assert_eq!(arr[ ..3], ['a', 'b', 'c', ]);
|
|
|
|
/// assert_eq!(arr[1.. ], [ 'b', 'c', 'd']);
|
|
|
|
/// assert_eq!(arr[1..3], [ 'b', 'c' ]); // Range
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
2017-06-30 08:34:53 -10:00
|
|
|
#[derive(Clone, PartialEq, Eq, Hash)] // not Copy -- see #27186
|
2017-06-07 21:44:03 -04:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
pub struct Range<Idx> {
|
|
|
|
/// The lower bound of the range (inclusive).
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
pub start: Idx,
|
|
|
|
/// The upper bound of the range (exclusive).
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
pub end: Idx,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
impl<Idx: fmt::Debug> fmt::Debug for Range<Idx> {
|
|
|
|
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
write!(fmt, "{:?}..{:?}", self.start, self.end)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<Idx: PartialOrd<Idx>> Range<Idx> {
|
2017-08-07 22:55:20 +02:00
|
|
|
/// Returns `true` if `item` is contained in the range.
|
|
|
|
///
|
2017-06-07 21:44:03 -04:00
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// #![feature(range_contains)]
|
|
|
|
///
|
2018-04-07 18:34:12 -07:00
|
|
|
/// assert!(!(3..5).contains(&2));
|
|
|
|
/// assert!( (3..5).contains(&3));
|
|
|
|
/// assert!( (3..5).contains(&4));
|
|
|
|
/// assert!(!(3..5).contains(&5));
|
2017-08-07 22:55:20 +02:00
|
|
|
///
|
2018-04-07 18:34:12 -07:00
|
|
|
/// assert!(!(3..3).contains(&3));
|
|
|
|
/// assert!(!(3..2).contains(&3));
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
2018-02-09 01:47:18 -08:00
|
|
|
#[unstable(feature = "range_contains", reason = "recently added as per RFC", issue = "32311")]
|
2018-04-07 15:47:18 -07:00
|
|
|
pub fn contains<U>(&self, item: &U) -> bool
|
|
|
|
where
|
|
|
|
Idx: PartialOrd<U>,
|
|
|
|
U: ?Sized,
|
|
|
|
{
|
|
|
|
<Self as RangeBounds<Idx>>::contains(self, item)
|
2017-06-07 21:44:03 -04:00
|
|
|
}
|
2018-02-09 01:47:18 -08:00
|
|
|
|
|
|
|
/// Returns `true` if the range contains no items.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// #![feature(range_is_empty)]
|
|
|
|
///
|
|
|
|
/// assert!(!(3..5).is_empty());
|
|
|
|
/// assert!( (3..3).is_empty());
|
|
|
|
/// assert!( (3..2).is_empty());
|
|
|
|
/// ```
|
2018-02-10 16:32:05 -08:00
|
|
|
///
|
|
|
|
/// The range is empty if either side is incomparable:
|
|
|
|
///
|
|
|
|
/// ```
|
2018-01-28 03:19:29 +08:00
|
|
|
/// #![feature(range_is_empty)]
|
2018-02-10 16:32:05 -08:00
|
|
|
///
|
|
|
|
/// use std::f32::NAN;
|
|
|
|
/// assert!(!(3.0..5.0).is_empty());
|
|
|
|
/// assert!( (3.0..NAN).is_empty());
|
|
|
|
/// assert!( (NAN..5.0).is_empty());
|
|
|
|
/// ```
|
2018-02-09 18:01:12 -08:00
|
|
|
#[unstable(feature = "range_is_empty", reason = "recently added", issue = "48111")]
|
2018-02-09 01:47:18 -08:00
|
|
|
pub fn is_empty(&self) -> bool {
|
|
|
|
!(self.start < self.end)
|
|
|
|
}
|
2017-06-07 21:44:03 -04:00
|
|
|
}
|
|
|
|
|
2017-08-07 22:55:20 +02:00
|
|
|
/// A range only bounded inclusively below (`start..`).
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// The `RangeFrom` `start..` contains all values with `x >= start`.
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// *Note*: Currently, no overflow checking is done for the [`Iterator`]
|
2017-06-07 21:44:03 -04:00
|
|
|
/// implementation; if you use an integer range and the integer overflows, it
|
2017-08-07 22:55:20 +02:00
|
|
|
/// might panic in debug mode or create an endless loop in release mode. **This
|
|
|
|
/// overflow behavior might change in the future.**
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2017-08-07 22:55:20 +02:00
|
|
|
/// assert_eq!((2..), std::ops::RangeFrom { start: 2 });
|
|
|
|
/// assert_eq!(2 + 3 + 4, (2..).take(3).sum());
|
|
|
|
///
|
|
|
|
/// let arr = [0, 1, 2, 3];
|
|
|
|
/// assert_eq!(arr[ .. ], [0,1,2,3]);
|
|
|
|
/// assert_eq!(arr[ ..3], [0,1,2 ]);
|
|
|
|
/// assert_eq!(arr[1.. ], [ 1,2,3]); // RangeFrom
|
|
|
|
/// assert_eq!(arr[1..3], [ 1,2 ]);
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
2017-08-07 22:55:20 +02:00
|
|
|
///
|
|
|
|
/// [`Iterator`]: ../iter/trait.IntoIterator.html
|
2017-06-30 08:34:53 -10:00
|
|
|
#[derive(Clone, PartialEq, Eq, Hash)] // not Copy -- see #27186
|
2017-06-07 21:44:03 -04:00
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
pub struct RangeFrom<Idx> {
|
|
|
|
/// The lower bound of the range (inclusive).
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
pub start: Idx,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
impl<Idx: fmt::Debug> fmt::Debug for RangeFrom<Idx> {
|
|
|
|
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
write!(fmt, "{:?}..", self.start)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<Idx: PartialOrd<Idx>> RangeFrom<Idx> {
|
2017-08-07 22:55:20 +02:00
|
|
|
/// Returns `true` if `item` is contained in the range.
|
|
|
|
///
|
2017-06-07 21:44:03 -04:00
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// #![feature(range_contains)]
|
2017-08-07 22:55:20 +02:00
|
|
|
///
|
2018-04-07 18:34:12 -07:00
|
|
|
/// assert!(!(3..).contains(&2));
|
|
|
|
/// assert!( (3..).contains(&3));
|
|
|
|
/// assert!( (3..).contains(&1_000_000_000));
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
2018-04-07 15:47:18 -07:00
|
|
|
#[unstable(feature = "range_contains", reason = "recently added as per RFC", issue = "32311")]
|
|
|
|
pub fn contains<U>(&self, item: &U) -> bool
|
|
|
|
where
|
|
|
|
Idx: PartialOrd<U>,
|
|
|
|
U: ?Sized,
|
|
|
|
{
|
|
|
|
<Self as RangeBounds<Idx>>::contains(self, item)
|
2017-06-07 21:44:03 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-08-07 22:55:20 +02:00
|
|
|
/// A range only bounded exclusively above (`..end`).
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// The `RangeTo` `..end` contains all values with `x < end`.
|
|
|
|
/// It cannot serve as an [`Iterator`] because it doesn't have a starting point.
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// The `..end` syntax is a `RangeTo`:
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
|
|
|
/// ```
|
2017-08-07 22:55:20 +02:00
|
|
|
/// assert_eq!((..5), std::ops::RangeTo { end: 5 });
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// It does not have an [`IntoIterator`] implementation, so you can't use it in
|
|
|
|
/// a `for` loop directly. This won't compile:
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2017-06-20 15:15:16 +08:00
|
|
|
/// ```compile_fail,E0277
|
2017-08-08 14:34:37 +02:00
|
|
|
/// // error[E0277]: the trait bound `std::ops::RangeTo<{integer}>:
|
|
|
|
/// // std::iter::Iterator` is not satisfied
|
2017-06-07 21:44:03 -04:00
|
|
|
/// for i in ..5 {
|
|
|
|
/// // ...
|
|
|
|
/// }
|
|
|
|
/// ```
|
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// When used as a [slicing index], `RangeTo` produces a slice of all array
|
2017-06-07 21:44:03 -04:00
|
|
|
/// elements before the index indicated by `end`.
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// let arr = [0, 1, 2, 3];
|
|
|
|
/// assert_eq!(arr[ .. ], [0,1,2,3]);
|
|
|
|
/// assert_eq!(arr[ ..3], [0,1,2 ]); // RangeTo
|
|
|
|
/// assert_eq!(arr[1.. ], [ 1,2,3]);
|
|
|
|
/// assert_eq!(arr[1..3], [ 1,2 ]);
|
|
|
|
/// ```
|
2017-08-07 22:55:20 +02:00
|
|
|
///
|
|
|
|
/// [`IntoIterator`]: ../iter/trait.Iterator.html
|
|
|
|
/// [`Iterator`]: ../iter/trait.IntoIterator.html
|
|
|
|
/// [slicing index]: ../slice/trait.SliceIndex.html
|
2017-06-07 21:44:03 -04:00
|
|
|
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
pub struct RangeTo<Idx> {
|
|
|
|
/// The upper bound of the range (exclusive).
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
pub end: Idx,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
impl<Idx: fmt::Debug> fmt::Debug for RangeTo<Idx> {
|
|
|
|
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
write!(fmt, "..{:?}", self.end)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<Idx: PartialOrd<Idx>> RangeTo<Idx> {
|
2017-08-07 22:55:20 +02:00
|
|
|
/// Returns `true` if `item` is contained in the range.
|
|
|
|
///
|
2017-06-07 21:44:03 -04:00
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// #![feature(range_contains)]
|
2017-08-07 22:55:20 +02:00
|
|
|
///
|
2018-04-07 18:34:12 -07:00
|
|
|
/// assert!( (..5).contains(&-1_000_000_000));
|
|
|
|
/// assert!( (..5).contains(&4));
|
|
|
|
/// assert!(!(..5).contains(&5));
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
2018-04-07 15:47:18 -07:00
|
|
|
#[unstable(feature = "range_contains", reason = "recently added as per RFC", issue = "32311")]
|
|
|
|
pub fn contains<U>(&self, item: &U) -> bool
|
|
|
|
where
|
|
|
|
Idx: PartialOrd<U>,
|
|
|
|
U: ?Sized,
|
|
|
|
{
|
|
|
|
<Self as RangeBounds<Idx>>::contains(self, item)
|
2017-06-07 21:44:03 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-09-19 05:40:04 +00:00
|
|
|
/// An range bounded inclusively below and above (`start..=end`).
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2017-09-19 05:40:04 +00:00
|
|
|
/// The `RangeInclusive` `start..=end` contains all values with `x >= start`
|
2018-02-10 16:32:05 -08:00
|
|
|
/// and `x <= end`. It is empty unless `start <= end`.
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2018-02-09 17:54:27 -08:00
|
|
|
/// This iterator is [fused], but the specific values of `start` and `end` after
|
|
|
|
/// iteration has finished are **unspecified** other than that [`.is_empty()`]
|
|
|
|
/// will return `true` once no more values will be produced.
|
|
|
|
///
|
|
|
|
/// [fused]: ../iter/trait.FusedIterator.html
|
|
|
|
/// [`.is_empty()`]: #method.is_empty
|
|
|
|
///
|
2017-06-07 21:44:03 -04:00
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2018-03-15 02:50:55 +08:00
|
|
|
/// #![feature(inclusive_range_fields)]
|
|
|
|
///
|
2017-09-19 05:40:04 +00:00
|
|
|
/// assert_eq!((3..=5), std::ops::RangeInclusive { start: 3, end: 5 });
|
|
|
|
/// assert_eq!(3 + 4 + 5, (3..=5).sum());
|
2017-08-07 22:55:20 +02:00
|
|
|
///
|
|
|
|
/// let arr = [0, 1, 2, 3];
|
2017-09-19 05:40:04 +00:00
|
|
|
/// assert_eq!(arr[ ..=2], [0,1,2 ]);
|
|
|
|
/// assert_eq!(arr[1..=2], [ 1,2 ]); // RangeInclusive
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
2017-06-30 08:34:53 -10:00
|
|
|
#[derive(Clone, PartialEq, Eq, Hash)] // not Copy -- see #27186
|
2018-01-28 03:09:36 +08:00
|
|
|
#[stable(feature = "inclusive_range", since = "1.26.0")]
|
2017-06-07 21:44:03 -04:00
|
|
|
pub struct RangeInclusive<Idx> {
|
|
|
|
/// The lower bound of the range (inclusive).
|
2018-03-15 02:50:55 +08:00
|
|
|
#[unstable(feature = "inclusive_range_fields", issue = "49022")]
|
2017-06-07 21:44:03 -04:00
|
|
|
pub start: Idx,
|
|
|
|
/// The upper bound of the range (inclusive).
|
2018-03-15 02:50:55 +08:00
|
|
|
#[unstable(feature = "inclusive_range_fields", issue = "49022")]
|
2017-06-07 21:44:03 -04:00
|
|
|
pub end: Idx,
|
|
|
|
}
|
|
|
|
|
2018-01-28 03:09:36 +08:00
|
|
|
#[stable(feature = "inclusive_range", since = "1.26.0")]
|
2017-06-07 21:44:03 -04:00
|
|
|
impl<Idx: fmt::Debug> fmt::Debug for RangeInclusive<Idx> {
|
|
|
|
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
|
2017-09-19 05:40:04 +00:00
|
|
|
write!(fmt, "{:?}..={:?}", self.start, self.end)
|
2017-06-07 21:44:03 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<Idx: PartialOrd<Idx>> RangeInclusive<Idx> {
|
2017-08-07 22:55:20 +02:00
|
|
|
/// Returns `true` if `item` is contained in the range.
|
|
|
|
///
|
2017-06-07 21:44:03 -04:00
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2018-01-28 03:19:29 +08:00
|
|
|
/// #![feature(range_contains)]
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2018-04-07 18:34:12 -07:00
|
|
|
/// assert!(!(3..=5).contains(&2));
|
|
|
|
/// assert!( (3..=5).contains(&3));
|
|
|
|
/// assert!( (3..=5).contains(&4));
|
|
|
|
/// assert!( (3..=5).contains(&5));
|
|
|
|
/// assert!(!(3..=5).contains(&6));
|
2017-08-07 22:55:20 +02:00
|
|
|
///
|
2018-04-07 18:34:12 -07:00
|
|
|
/// assert!( (3..=3).contains(&3));
|
|
|
|
/// assert!(!(3..=2).contains(&3));
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
2018-02-09 01:47:18 -08:00
|
|
|
#[unstable(feature = "range_contains", reason = "recently added as per RFC", issue = "32311")]
|
2018-04-07 15:47:18 -07:00
|
|
|
pub fn contains<U>(&self, item: &U) -> bool
|
|
|
|
where
|
|
|
|
Idx: PartialOrd<U>,
|
|
|
|
U: ?Sized,
|
|
|
|
{
|
|
|
|
<Self as RangeBounds<Idx>>::contains(self, item)
|
2017-06-07 21:44:03 -04:00
|
|
|
}
|
2018-02-09 01:47:18 -08:00
|
|
|
|
|
|
|
/// Returns `true` if the range contains no items.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2018-01-28 03:19:29 +08:00
|
|
|
/// #![feature(range_is_empty)]
|
2018-02-09 01:47:18 -08:00
|
|
|
///
|
|
|
|
/// assert!(!(3..=5).is_empty());
|
|
|
|
/// assert!(!(3..=3).is_empty());
|
|
|
|
/// assert!( (3..=2).is_empty());
|
|
|
|
/// ```
|
2018-02-09 17:54:27 -08:00
|
|
|
///
|
2018-02-10 16:32:05 -08:00
|
|
|
/// The range is empty if either side is incomparable:
|
|
|
|
///
|
|
|
|
/// ```
|
2018-01-28 03:19:29 +08:00
|
|
|
/// #![feature(range_is_empty)]
|
2018-02-10 16:32:05 -08:00
|
|
|
///
|
|
|
|
/// use std::f32::NAN;
|
|
|
|
/// assert!(!(3.0..=5.0).is_empty());
|
|
|
|
/// assert!( (3.0..=NAN).is_empty());
|
|
|
|
/// assert!( (NAN..=5.0).is_empty());
|
|
|
|
/// ```
|
|
|
|
///
|
2018-02-09 17:54:27 -08:00
|
|
|
/// This method returns `true` after iteration has finished:
|
|
|
|
///
|
|
|
|
/// ```
|
2018-01-28 03:19:29 +08:00
|
|
|
/// #![feature(range_is_empty)]
|
2018-02-09 17:54:27 -08:00
|
|
|
///
|
|
|
|
/// let mut r = 3..=5;
|
|
|
|
/// for _ in r.by_ref() {}
|
|
|
|
/// // Precise field values are unspecified here
|
|
|
|
/// assert!(r.is_empty());
|
|
|
|
/// ```
|
2018-02-09 18:01:12 -08:00
|
|
|
#[unstable(feature = "range_is_empty", reason = "recently added", issue = "48111")]
|
2018-02-09 01:47:18 -08:00
|
|
|
pub fn is_empty(&self) -> bool {
|
|
|
|
!(self.start <= self.end)
|
|
|
|
}
|
2017-06-07 21:44:03 -04:00
|
|
|
}
|
|
|
|
|
2017-09-19 05:40:04 +00:00
|
|
|
/// A range only bounded inclusively above (`..=end`).
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
2017-09-19 05:40:04 +00:00
|
|
|
/// The `RangeToInclusive` `..=end` contains all values with `x <= end`.
|
2017-08-07 22:55:20 +02:00
|
|
|
/// It cannot serve as an [`Iterator`] because it doesn't have a starting point.
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
2017-09-19 05:40:04 +00:00
|
|
|
/// The `..=end` syntax is a `RangeToInclusive`:
|
2017-06-07 21:44:03 -04:00
|
|
|
///
|
|
|
|
/// ```
|
2017-09-19 05:40:04 +00:00
|
|
|
/// assert_eq!((..=5), std::ops::RangeToInclusive{ end: 5 });
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// It does not have an [`IntoIterator`] implementation, so you can't use it in a
|
2017-06-07 21:44:03 -04:00
|
|
|
/// `for` loop directly. This won't compile:
|
|
|
|
///
|
2017-06-20 15:15:16 +08:00
|
|
|
/// ```compile_fail,E0277
|
2017-08-08 14:34:37 +02:00
|
|
|
/// // error[E0277]: the trait bound `std::ops::RangeToInclusive<{integer}>:
|
|
|
|
/// // std::iter::Iterator` is not satisfied
|
2017-09-19 05:40:04 +00:00
|
|
|
/// for i in ..=5 {
|
2017-06-07 21:44:03 -04:00
|
|
|
/// // ...
|
|
|
|
/// }
|
|
|
|
/// ```
|
|
|
|
///
|
2017-08-07 22:55:20 +02:00
|
|
|
/// When used as a [slicing index], `RangeToInclusive` produces a slice of all
|
2017-06-07 21:44:03 -04:00
|
|
|
/// array elements up to and including the index indicated by `end`.
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// let arr = [0, 1, 2, 3];
|
2017-09-19 05:40:04 +00:00
|
|
|
/// assert_eq!(arr[ ..=2], [0,1,2 ]); // RangeToInclusive
|
|
|
|
/// assert_eq!(arr[1..=2], [ 1,2 ]);
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
2017-08-07 22:55:20 +02:00
|
|
|
///
|
|
|
|
/// [`IntoIterator`]: ../iter/trait.Iterator.html
|
|
|
|
/// [`Iterator`]: ../iter/trait.IntoIterator.html
|
|
|
|
/// [slicing index]: ../slice/trait.SliceIndex.html
|
2017-06-07 21:44:03 -04:00
|
|
|
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
|
2018-01-28 03:09:36 +08:00
|
|
|
#[stable(feature = "inclusive_range", since = "1.26.0")]
|
2017-06-07 21:44:03 -04:00
|
|
|
pub struct RangeToInclusive<Idx> {
|
|
|
|
/// The upper bound of the range (inclusive)
|
2018-01-28 03:09:36 +08:00
|
|
|
#[stable(feature = "inclusive_range", since = "1.26.0")]
|
2017-06-07 21:44:03 -04:00
|
|
|
pub end: Idx,
|
|
|
|
}
|
|
|
|
|
2018-01-28 03:09:36 +08:00
|
|
|
#[stable(feature = "inclusive_range", since = "1.26.0")]
|
2017-06-07 21:44:03 -04:00
|
|
|
impl<Idx: fmt::Debug> fmt::Debug for RangeToInclusive<Idx> {
|
|
|
|
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
|
2017-09-19 05:40:04 +00:00
|
|
|
write!(fmt, "..={:?}", self.end)
|
2017-06-07 21:44:03 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "range_contains", reason = "recently added as per RFC", issue = "32311")]
|
|
|
|
impl<Idx: PartialOrd<Idx>> RangeToInclusive<Idx> {
|
2017-08-07 22:55:20 +02:00
|
|
|
/// Returns `true` if `item` is contained in the range.
|
|
|
|
///
|
2017-06-07 21:44:03 -04:00
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
2018-01-28 03:19:29 +08:00
|
|
|
/// #![feature(range_contains)]
|
2017-08-07 22:55:20 +02:00
|
|
|
///
|
2018-04-07 18:34:12 -07:00
|
|
|
/// assert!( (..=5).contains(&-1_000_000_000));
|
|
|
|
/// assert!( (..=5).contains(&5));
|
|
|
|
/// assert!(!(..=5).contains(&6));
|
2017-06-07 21:44:03 -04:00
|
|
|
/// ```
|
2018-04-07 15:47:18 -07:00
|
|
|
#[unstable(feature = "range_contains", reason = "recently added as per RFC", issue = "32311")]
|
|
|
|
pub fn contains<U>(&self, item: &U) -> bool
|
|
|
|
where
|
|
|
|
Idx: PartialOrd<U>,
|
|
|
|
U: ?Sized,
|
|
|
|
{
|
|
|
|
<Self as RangeBounds<Idx>>::contains(self, item)
|
2017-06-07 21:44:03 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// RangeToInclusive<Idx> cannot impl From<RangeTo<Idx>>
|
|
|
|
// because underflow would be possible with (..0).into()
|
2018-03-19 09:01:17 +01:00
|
|
|
|
|
|
|
/// An endpoint of a range of keys.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// `Bound`s are range endpoints:
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// #![feature(collections_range)]
|
|
|
|
///
|
|
|
|
/// use std::ops::Bound::*;
|
2018-03-19 09:26:29 +01:00
|
|
|
/// use std::ops::RangeBounds;
|
2018-03-19 09:01:17 +01:00
|
|
|
///
|
|
|
|
/// assert_eq!((..100).start(), Unbounded);
|
|
|
|
/// assert_eq!((1..12).start(), Included(&1));
|
|
|
|
/// assert_eq!((1..12).end(), Excluded(&12));
|
|
|
|
/// ```
|
|
|
|
///
|
|
|
|
/// Using a tuple of `Bound`s as an argument to [`BTreeMap::range`].
|
|
|
|
/// Note that in most cases, it's better to use range syntax (`1..5`) instead.
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// use std::collections::BTreeMap;
|
|
|
|
/// use std::ops::Bound::{Excluded, Included, Unbounded};
|
|
|
|
///
|
|
|
|
/// let mut map = BTreeMap::new();
|
|
|
|
/// map.insert(3, "a");
|
|
|
|
/// map.insert(5, "b");
|
|
|
|
/// map.insert(8, "c");
|
|
|
|
///
|
|
|
|
/// for (key, value) in map.range((Excluded(3), Included(8))) {
|
|
|
|
/// println!("{}: {}", key, value);
|
|
|
|
/// }
|
|
|
|
///
|
|
|
|
/// assert_eq!(Some((&3, &"a")), map.range((Unbounded, Included(5))).next());
|
|
|
|
/// ```
|
|
|
|
///
|
|
|
|
/// [`BTreeMap::range`]: ../../std/collections/btree_map/struct.BTreeMap.html#method.range
|
|
|
|
#[stable(feature = "collections_bound", since = "1.17.0")]
|
|
|
|
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
|
|
|
|
pub enum Bound<T> {
|
|
|
|
/// An inclusive bound.
|
|
|
|
#[stable(feature = "collections_bound", since = "1.17.0")]
|
|
|
|
Included(#[stable(feature = "collections_bound", since = "1.17.0")] T),
|
|
|
|
/// An exclusive bound.
|
|
|
|
#[stable(feature = "collections_bound", since = "1.17.0")]
|
|
|
|
Excluded(#[stable(feature = "collections_bound", since = "1.17.0")] T),
|
|
|
|
/// An infinite endpoint. Indicates that there is no bound in this direction.
|
|
|
|
#[stable(feature = "collections_bound", since = "1.17.0")]
|
|
|
|
Unbounded,
|
|
|
|
}
|
2018-03-19 09:26:29 +01:00
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
/// `RangeBounds` is implemented by Rust's built-in range types, produced
|
|
|
|
/// by range syntax like `..`, `a..`, `..b` or `c..d`.
|
|
|
|
pub trait RangeBounds<T: ?Sized> {
|
|
|
|
/// Start index bound.
|
|
|
|
///
|
|
|
|
/// Returns the start value as a `Bound`.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// #![feature(collections_range)]
|
|
|
|
///
|
|
|
|
/// # fn main() {
|
|
|
|
/// use std::ops::Bound::*;
|
|
|
|
/// use std::ops::RangeBounds;
|
|
|
|
///
|
|
|
|
/// assert_eq!((..10).start(), Unbounded);
|
|
|
|
/// assert_eq!((3..10).start(), Included(&3));
|
|
|
|
/// # }
|
|
|
|
/// ```
|
|
|
|
fn start(&self) -> Bound<&T>;
|
|
|
|
|
|
|
|
/// End index bound.
|
|
|
|
///
|
|
|
|
/// Returns the end value as a `Bound`.
|
|
|
|
///
|
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// #![feature(collections_range)]
|
|
|
|
///
|
|
|
|
/// # fn main() {
|
|
|
|
/// use std::ops::Bound::*;
|
|
|
|
/// use std::ops::RangeBounds;
|
|
|
|
///
|
|
|
|
/// assert_eq!((3..).end(), Unbounded);
|
|
|
|
/// assert_eq!((3..10).end(), Excluded(&10));
|
|
|
|
/// # }
|
|
|
|
/// ```
|
|
|
|
fn end(&self) -> Bound<&T>;
|
2018-04-07 15:47:18 -07:00
|
|
|
|
|
|
|
/// Returns `true` if `item` is contained in the range.
|
|
|
|
#[unstable(feature = "range_contains", reason = "recently added as per RFC", issue = "32311")]
|
|
|
|
fn contains<U>(&self, item: &U) -> bool
|
|
|
|
where
|
|
|
|
T: PartialOrd<U>,
|
|
|
|
U: ?Sized,
|
|
|
|
{
|
|
|
|
match self.start() {
|
|
|
|
Included(ref start) => if *start > item {
|
|
|
|
return false;
|
|
|
|
},
|
|
|
|
Excluded(ref start) => if *start >= item {
|
|
|
|
return false;
|
|
|
|
},
|
|
|
|
Unbounded => (),
|
|
|
|
};
|
|
|
|
|
|
|
|
match self.end() {
|
|
|
|
Included(ref end) => if *end < item {
|
|
|
|
return false;
|
|
|
|
},
|
|
|
|
Excluded(ref end) => if *end <= item {
|
|
|
|
return false;
|
|
|
|
},
|
|
|
|
Unbounded => (),
|
|
|
|
}
|
|
|
|
|
|
|
|
true
|
|
|
|
}
|
2018-03-19 09:26:29 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
use self::Bound::{Excluded, Included, Unbounded};
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<T: ?Sized> RangeBounds<T> for RangeFull {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Unbounded
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Unbounded
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<T> RangeBounds<T> for RangeFrom<T> {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Included(&self.start)
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Unbounded
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<T> RangeBounds<T> for RangeTo<T> {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Unbounded
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Excluded(&self.end)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<T> RangeBounds<T> for Range<T> {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Included(&self.start)
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Excluded(&self.end)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<T> RangeBounds<T> for RangeInclusive<T> {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Included(&self.start)
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Included(&self.end)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<T> RangeBounds<T> for RangeToInclusive<T> {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Unbounded
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Included(&self.end)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<T> RangeBounds<T> for (Bound<T>, Bound<T>) {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
match *self {
|
|
|
|
(Included(ref start), _) => Included(start),
|
|
|
|
(Excluded(ref start), _) => Excluded(start),
|
|
|
|
(Unbounded, _) => Unbounded,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
match *self {
|
|
|
|
(_, Included(ref end)) => Included(end),
|
|
|
|
(_, Excluded(ref end)) => Excluded(end),
|
|
|
|
(_, Unbounded) => Unbounded,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<'a, T: ?Sized + 'a> RangeBounds<T> for (Bound<&'a T>, Bound<&'a T>) {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
self.0
|
|
|
|
}
|
|
|
|
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
self.1
|
|
|
|
}
|
|
|
|
}
|
2018-03-20 19:46:11 +01:00
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<'a, T> RangeBounds<T> for RangeFrom<&'a T> {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Included(self.start)
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Unbounded
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<'a, T> RangeBounds<T> for RangeTo<&'a T> {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Unbounded
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Excluded(self.end)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<'a, T> RangeBounds<T> for Range<&'a T> {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Included(self.start)
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Excluded(self.end)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<'a, T> RangeBounds<T> for RangeInclusive<&'a T> {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Included(self.start)
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Included(self.end)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[unstable(feature = "collections_range",
|
|
|
|
reason = "might be replaced with `Into<_>` and a type containing two `Bound` values",
|
|
|
|
issue = "30877")]
|
|
|
|
impl<'a, T> RangeBounds<T> for RangeToInclusive<&'a T> {
|
|
|
|
fn start(&self) -> Bound<&T> {
|
|
|
|
Unbounded
|
|
|
|
}
|
|
|
|
fn end(&self) -> Bound<&T> {
|
|
|
|
Included(self.end)
|
|
|
|
}
|
|
|
|
}
|