1856 lines
54 KiB
Rust
1856 lines
54 KiB
Rust
// Copyright 2012-2014 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.
|
|
|
|
//! Slice management and manipulation
|
|
//!
|
|
//! For more details `std::slice`.
|
|
|
|
#![stable]
|
|
#![doc(primitive = "slice")]
|
|
|
|
// How this module is organized.
|
|
//
|
|
// The library infrastructure for slices is fairly messy. There's
|
|
// a lot of stuff defined here. Let's keep it clean.
|
|
//
|
|
// Since slices don't support inherent methods; all operations
|
|
// on them are defined on traits, which are then reexported from
|
|
// the prelude for convenience. So there are a lot of traits here.
|
|
//
|
|
// The layout of this file is thus:
|
|
//
|
|
// * Slice-specific 'extension' traits and their implementations. This
|
|
// is where most of the slice API resides.
|
|
// * Implementations of a few common traits with important slice ops.
|
|
// * Definitions of a bunch of iterators.
|
|
// * Free functions.
|
|
// * The `raw` and `bytes` submodules.
|
|
// * Boilerplate trait implementations.
|
|
|
|
use mem::transmute;
|
|
use clone::Clone;
|
|
use collections::Collection;
|
|
use cmp::{PartialEq, PartialOrd, Eq, Ord, Ordering, Less, Equal, Greater, Equiv};
|
|
use cmp;
|
|
use default::Default;
|
|
use iter::*;
|
|
use num::{CheckedAdd, Saturating, div_rem};
|
|
use ops;
|
|
use option::{None, Option, Some};
|
|
use ptr;
|
|
use ptr::RawPtr;
|
|
use mem;
|
|
use mem::size_of;
|
|
use kinds::marker;
|
|
use raw::Repr;
|
|
// Avoid conflicts with *both* the Slice trait (buggy) and the `slice::raw` module.
|
|
use raw::Slice as RawSlice;
|
|
|
|
|
|
//
|
|
// Extension traits
|
|
//
|
|
|
|
/// Extension methods for immutable slices.
|
|
#[unstable = "may merge with other traits; region parameter may disappear"]
|
|
pub trait ImmutableSlice<'a, T> {
|
|
/// Returns a subslice spanning the interval [`start`, `end`).
|
|
///
|
|
/// Fails when the end of the new slice lies beyond the end of the
|
|
/// original slice (i.e. when `end > self.len()`) or when `start > end`.
|
|
///
|
|
/// Slicing with `start` equal to `end` yields an empty slice.
|
|
#[unstable = "waiting on final error conventions"]
|
|
fn slice(&self, start: uint, end: uint) -> &'a [T];
|
|
|
|
/// Returns a subslice from `start` to the end of the slice.
|
|
///
|
|
/// Fails when `start` is strictly greater than the length of the original slice.
|
|
///
|
|
/// Slicing from `self.len()` yields an empty slice.
|
|
#[unstable = "waiting on final error conventions"]
|
|
fn slice_from(&self, start: uint) -> &'a [T];
|
|
|
|
/// Returns a subslice from the start of the slice to `end`.
|
|
///
|
|
/// Fails when `end` is strictly greater than the length of the original slice.
|
|
///
|
|
/// Slicing to `0` yields an empty slice.
|
|
#[unstable = "waiting on final error conventions"]
|
|
fn slice_to(&self, end: uint) -> &'a [T];
|
|
|
|
/// Divides one slice into two at an index.
|
|
///
|
|
/// The first will contain all indices from `[0, mid)` (excluding
|
|
/// the index `mid` itself) and the second will contain all
|
|
/// indices from `[mid, len)` (excluding the index `len` itself).
|
|
///
|
|
/// Fails if `mid > len`.
|
|
#[unstable = "waiting on final error conventions"]
|
|
fn split_at(&self, mid: uint) -> (&'a [T], &'a [T]);
|
|
|
|
/// Returns an iterator over the slice
|
|
#[unstable = "iterator type may change"]
|
|
fn iter(self) -> Items<'a, T>;
|
|
|
|
/// Returns an iterator over subslices separated by elements that match
|
|
/// `pred`. The matched element is not contained in the subslices.
|
|
#[unstable = "iterator type may change, waiting on unboxed closures"]
|
|
fn split(self, pred: |&T|: 'a -> bool) -> Splits<'a, T>;
|
|
|
|
/// Returns an iterator over subslices separated by elements that match
|
|
/// `pred`, limited to splitting at most `n` times. The matched element is
|
|
/// not contained in the subslices.
|
|
#[unstable = "iterator type may change"]
|
|
fn splitn(self, n: uint, pred: |&T|: 'a -> bool) -> SplitsN<Splits<'a, T>>;
|
|
|
|
/// Returns an iterator over subslices separated by elements that match
|
|
/// `pred` limited to splitting at most `n` times. This starts at the end of
|
|
/// the slice and works backwards. The matched element is not contained in
|
|
/// the subslices.
|
|
#[unstable = "iterator type may change"]
|
|
fn rsplitn(self, n: uint, pred: |&T|: 'a -> bool) -> SplitsN<Splits<'a, T>>;
|
|
|
|
/// Returns an iterator over all contiguous windows of length
|
|
/// `size`. The windows overlap. If the slice is shorter than
|
|
/// `size`, the iterator returns no values.
|
|
///
|
|
/// # Failure
|
|
///
|
|
/// Fails if `size` is 0.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// Print the adjacent pairs of a slice (i.e. `[1,2]`, `[2,3]`,
|
|
/// `[3,4]`):
|
|
///
|
|
/// ```rust
|
|
/// let v = &[1i, 2, 3, 4];
|
|
/// for win in v.windows(2) {
|
|
/// println!("{}", win);
|
|
/// }
|
|
/// ```
|
|
#[unstable = "iterator type may change"]
|
|
fn windows(self, size: uint) -> Windows<'a, T>;
|
|
|
|
/// Returns an iterator over `size` elements of the slice at a
|
|
/// time. The chunks do not overlap. If `size` does not divide the
|
|
/// length of the slice, then the last chunk will not have length
|
|
/// `size`.
|
|
///
|
|
/// # Failure
|
|
///
|
|
/// Fails if `size` is 0.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// Print the slice two elements at a time (i.e. `[1,2]`,
|
|
/// `[3,4]`, `[5]`):
|
|
///
|
|
/// ```rust
|
|
/// let v = &[1i, 2, 3, 4, 5];
|
|
/// for win in v.chunks(2) {
|
|
/// println!("{}", win);
|
|
/// }
|
|
/// ```
|
|
#[unstable = "iterator type may change"]
|
|
fn chunks(self, size: uint) -> Chunks<'a, T>;
|
|
|
|
/// Returns the element of a slice at the given index, or `None` if the
|
|
/// index is out of bounds.
|
|
#[unstable = "waiting on final collection conventions"]
|
|
fn get(&self, index: uint) -> Option<&'a T>;
|
|
|
|
/// Returns the first element of a slice, or `None` if it is empty.
|
|
#[unstable = "name may change"]
|
|
fn head(&self) -> Option<&'a T>;
|
|
|
|
/// Returns all but the first element of a slice.
|
|
#[unstable = "name may change"]
|
|
fn tail(&self) -> &'a [T];
|
|
|
|
/// Returns all but the first `n' elements of a slice.
|
|
#[deprecated = "use slice_from"]
|
|
fn tailn(&self, n: uint) -> &'a [T];
|
|
|
|
/// Returns all but the last element of a slice.
|
|
#[unstable = "name may change"]
|
|
fn init(&self) -> &'a [T];
|
|
|
|
/// Returns all but the last `n' elements of a slice.
|
|
#[deprecated = "use slice_to but note the arguments are different"]
|
|
fn initn(&self, n: uint) -> &'a [T];
|
|
|
|
/// Returns the last element of a slice, or `None` if it is empty.
|
|
#[unstable = "name may change"]
|
|
fn last(&self) -> Option<&'a T>;
|
|
|
|
/// Returns a pointer to the element at the given index, without doing
|
|
/// bounds checking.
|
|
#[deprecated = "renamed to `unsafe_get`"]
|
|
unsafe fn unsafe_ref(self, index: uint) -> &'a T;
|
|
|
|
/// Returns a pointer to the element at the given index, without doing
|
|
/// bounds checking.
|
|
#[unstable]
|
|
unsafe fn unsafe_get(self, index: uint) -> &'a T;
|
|
|
|
/// Returns an unsafe pointer to the slice's buffer
|
|
///
|
|
/// The caller must ensure that the slice outlives the pointer this
|
|
/// function returns, or else it will end up pointing to garbage.
|
|
///
|
|
/// Modifying the slice may cause its buffer to be reallocated, which
|
|
/// would also make any pointers to it invalid.
|
|
#[unstable]
|
|
fn as_ptr(&self) -> *const T;
|
|
|
|
/// Deprecated: use `binary_search`.
|
|
#[deprecated = "use binary_search"]
|
|
fn bsearch(&self, f: |&T| -> Ordering) -> Option<uint>;
|
|
|
|
/// Binary search a sorted slice with a comparator function.
|
|
///
|
|
/// The comparator function should implement an order consistent
|
|
/// with the sort order of the underlying slice, returning an
|
|
/// order code that indicates whether its argument is `Less`,
|
|
/// `Equal` or `Greater` the desired target.
|
|
///
|
|
/// If the value is found then `Found` is returned, containing the
|
|
/// index of the matching element; if the value is not found then
|
|
/// `NotFound` is returned, containing the index where a matching
|
|
/// element could be inserted while maintaining sorted order.
|
|
#[unstable = "waiting on unboxed closures"]
|
|
fn binary_search(&self, f: |&T| -> Ordering) -> BinarySearchResult;
|
|
|
|
/**
|
|
* Returns an immutable reference to the first element in this slice
|
|
* and adjusts the slice in place so that it no longer contains
|
|
* that element. O(1).
|
|
*
|
|
* Equivalent to:
|
|
*
|
|
* ```ignore
|
|
* if self.len() == 0 { return None }
|
|
* let head = &self[0];
|
|
* *self = self.slice_from(1);
|
|
* Some(head)
|
|
* ```
|
|
*
|
|
* Returns `None` if vector is empty
|
|
*/
|
|
#[deprecated = "find some other way. sorry"]
|
|
fn shift_ref(&mut self) -> Option<&'a T>;
|
|
|
|
/**
|
|
* Returns an immutable reference to the last element in this slice
|
|
* and adjusts the slice in place so that it no longer contains
|
|
* that element. O(1).
|
|
*
|
|
* Equivalent to:
|
|
*
|
|
* ```ignore
|
|
* if self.len() == 0 { return None; }
|
|
* let tail = &self[self.len() - 1];
|
|
* *self = self.slice_to(self.len() - 1);
|
|
* Some(tail)
|
|
* ```
|
|
*
|
|
* Returns `None` if slice is empty.
|
|
*/
|
|
#[deprecated = "find some other way. sorry"]
|
|
fn pop_ref(&mut self) -> Option<&'a T>;
|
|
}
|
|
|
|
#[unstable]
|
|
impl<'a,T> ImmutableSlice<'a, T> for &'a [T] {
|
|
#[inline]
|
|
fn slice(&self, start: uint, end: uint) -> &'a [T] {
|
|
assert!(start <= end);
|
|
assert!(end <= self.len());
|
|
unsafe {
|
|
transmute(RawSlice {
|
|
data: self.as_ptr().offset(start as int),
|
|
len: (end - start)
|
|
})
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn slice_from(&self, start: uint) -> &'a [T] {
|
|
self.slice(start, self.len())
|
|
}
|
|
|
|
#[inline]
|
|
fn slice_to(&self, end: uint) -> &'a [T] {
|
|
self.slice(0, end)
|
|
}
|
|
|
|
#[inline]
|
|
fn split_at(&self, mid: uint) -> (&'a [T], &'a [T]) {
|
|
(self.slice(0, mid), self.slice(mid, self.len()))
|
|
}
|
|
|
|
#[inline]
|
|
fn iter(self) -> Items<'a, T> {
|
|
unsafe {
|
|
let p = self.as_ptr();
|
|
if mem::size_of::<T>() == 0 {
|
|
Items{ptr: p,
|
|
end: (p as uint + self.len()) as *const T,
|
|
marker: marker::ContravariantLifetime::<'a>}
|
|
} else {
|
|
Items{ptr: p,
|
|
end: p.offset(self.len() as int),
|
|
marker: marker::ContravariantLifetime::<'a>}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn split(self, pred: |&T|: 'a -> bool) -> Splits<'a, T> {
|
|
Splits {
|
|
v: self,
|
|
pred: pred,
|
|
finished: false
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn splitn(self, n: uint, pred: |&T|: 'a -> bool) -> SplitsN<Splits<'a, T>> {
|
|
SplitsN {
|
|
iter: self.split(pred),
|
|
count: n,
|
|
invert: false
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn rsplitn(self, n: uint, pred: |&T|: 'a -> bool) -> SplitsN<Splits<'a, T>> {
|
|
SplitsN {
|
|
iter: self.split(pred),
|
|
count: n,
|
|
invert: true
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn windows(self, size: uint) -> Windows<'a, T> {
|
|
assert!(size != 0);
|
|
Windows { v: self, size: size }
|
|
}
|
|
|
|
#[inline]
|
|
fn chunks(self, size: uint) -> Chunks<'a, T> {
|
|
assert!(size != 0);
|
|
Chunks { v: self, size: size }
|
|
}
|
|
|
|
#[inline]
|
|
fn get(&self, index: uint) -> Option<&'a T> {
|
|
if index < self.len() { Some(&self[index]) } else { None }
|
|
}
|
|
|
|
#[inline]
|
|
fn head(&self) -> Option<&'a T> {
|
|
if self.len() == 0 { None } else { Some(&self[0]) }
|
|
}
|
|
|
|
#[inline]
|
|
fn tail(&self) -> &'a [T] { self.slice(1, self.len()) }
|
|
|
|
#[inline]
|
|
#[deprecated = "use slice_from"]
|
|
fn tailn(&self, n: uint) -> &'a [T] { self.slice(n, self.len()) }
|
|
|
|
#[inline]
|
|
fn init(&self) -> &'a [T] {
|
|
self.slice(0, self.len() - 1)
|
|
}
|
|
|
|
#[inline]
|
|
#[deprecated = "use slice_to but note the arguments are different"]
|
|
fn initn(&self, n: uint) -> &'a [T] {
|
|
self.slice(0, self.len() - n)
|
|
}
|
|
|
|
#[inline]
|
|
fn last(&self) -> Option<&'a T> {
|
|
if self.len() == 0 { None } else { Some(&self[self.len() - 1]) }
|
|
}
|
|
|
|
#[inline]
|
|
#[deprecated = "renamed to `unsafe_get`"]
|
|
unsafe fn unsafe_ref(self, index: uint) -> &'a T {
|
|
transmute(self.repr().data.offset(index as int))
|
|
}
|
|
|
|
#[inline]
|
|
unsafe fn unsafe_get(self, index: uint) -> &'a T {
|
|
transmute(self.repr().data.offset(index as int))
|
|
}
|
|
|
|
#[inline]
|
|
fn as_ptr(&self) -> *const T {
|
|
self.repr().data
|
|
}
|
|
|
|
|
|
#[deprecated = "use binary_search"]
|
|
fn bsearch(&self, f: |&T| -> Ordering) -> Option<uint> {
|
|
let mut base : uint = 0;
|
|
let mut lim : uint = self.len();
|
|
|
|
while lim != 0 {
|
|
let ix = base + (lim >> 1);
|
|
match f(&self[ix]) {
|
|
Equal => return Some(ix),
|
|
Less => {
|
|
base = ix + 1;
|
|
lim -= 1;
|
|
}
|
|
Greater => ()
|
|
}
|
|
lim >>= 1;
|
|
}
|
|
return None;
|
|
}
|
|
|
|
#[unstable]
|
|
fn binary_search(&self, f: |&T| -> Ordering) -> BinarySearchResult {
|
|
let mut base : uint = 0;
|
|
let mut lim : uint = self.len();
|
|
|
|
while lim != 0 {
|
|
let ix = base + (lim >> 1);
|
|
match f(&self[ix]) {
|
|
Equal => return Found(ix),
|
|
Less => {
|
|
base = ix + 1;
|
|
lim -= 1;
|
|
}
|
|
Greater => ()
|
|
}
|
|
lim >>= 1;
|
|
}
|
|
return NotFound(base);
|
|
}
|
|
|
|
fn shift_ref(&mut self) -> Option<&'a T> {
|
|
unsafe {
|
|
let s: &mut RawSlice<T> = transmute(self);
|
|
match raw::shift_ptr(s) {
|
|
Some(p) => Some(&*p),
|
|
None => None
|
|
}
|
|
}
|
|
}
|
|
|
|
fn pop_ref(&mut self) -> Option<&'a T> {
|
|
unsafe {
|
|
let s: &mut RawSlice<T> = transmute(self);
|
|
match raw::pop_ptr(s) {
|
|
Some(p) => Some(&*p),
|
|
None => None
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<T> ops::Slice<uint, [T]> for [T] {
|
|
#[inline]
|
|
fn as_slice_<'a>(&'a self) -> &'a [T] {
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
fn slice_from_<'a>(&'a self, start: &uint) -> &'a [T] {
|
|
self.slice_(start, &self.len())
|
|
}
|
|
|
|
#[inline]
|
|
fn slice_to_<'a>(&'a self, end: &uint) -> &'a [T] {
|
|
self.slice_(&0, end)
|
|
}
|
|
#[inline]
|
|
fn slice_<'a>(&'a self, start: &uint, end: &uint) -> &'a [T] {
|
|
assert!(*start <= *end);
|
|
assert!(*end <= self.len());
|
|
unsafe {
|
|
transmute(RawSlice {
|
|
data: self.as_ptr().offset(*start as int),
|
|
len: (*end - *start)
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<T> ops::SliceMut<uint, [T]> for [T] {
|
|
#[inline]
|
|
fn as_mut_slice_<'a>(&'a mut self) -> &'a mut [T] {
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
fn slice_from_mut_<'a>(&'a mut self, start: &uint) -> &'a mut [T] {
|
|
let len = &self.len();
|
|
self.slice_mut_(start, len)
|
|
}
|
|
|
|
#[inline]
|
|
fn slice_to_mut_<'a>(&'a mut self, end: &uint) -> &'a mut [T] {
|
|
self.slice_mut_(&0, end)
|
|
}
|
|
#[inline]
|
|
fn slice_mut_<'a>(&'a mut self, start: &uint, end: &uint) -> &'a mut [T] {
|
|
assert!(*start <= *end);
|
|
assert!(*end <= self.len());
|
|
unsafe {
|
|
transmute(RawSlice {
|
|
data: self.as_ptr().offset(*start as int),
|
|
len: (*end - *start)
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Extension methods for slices such that their elements are
|
|
/// mutable.
|
|
#[experimental = "may merge with other traits; may lose region param; needs review"]
|
|
pub trait MutableSlice<'a, T> {
|
|
/// Returns a mutable reference to the element at the given index,
|
|
/// or `None` if the index is out of bounds
|
|
#[unstable = "waiting on final error conventions"]
|
|
fn get_mut(self, index: uint) -> Option<&'a mut T>;
|
|
/// Work with `self` as a mut slice.
|
|
/// Primarily intended for getting a &mut [T] from a [T, ..N].
|
|
fn as_mut_slice(self) -> &'a mut [T];
|
|
|
|
/// Deprecated: use `slice_mut`.
|
|
#[deprecated = "use slice_mut"]
|
|
fn mut_slice(self, start: uint, end: uint) -> &'a mut [T] {
|
|
self.slice_mut(start, end)
|
|
}
|
|
|
|
/// Returns a mutable subslice spanning the interval [`start`, `end`).
|
|
///
|
|
/// Fails when the end of the new slice lies beyond the end of the
|
|
/// original slice (i.e. when `end > self.len()`) or when `start > end`.
|
|
///
|
|
/// Slicing with `start` equal to `end` yields an empty slice.
|
|
#[unstable = "waiting on final error conventions"]
|
|
fn slice_mut(self, start: uint, end: uint) -> &'a mut [T];
|
|
|
|
/// Deprecated: use `slice_from_mut`.
|
|
#[deprecated = "use slice_from_mut"]
|
|
fn mut_slice_from(self, start: uint) -> &'a mut [T] {
|
|
self.slice_from_mut(start)
|
|
}
|
|
|
|
/// Returns a mutable subslice from `start` to the end of the slice.
|
|
///
|
|
/// Fails when `start` is strictly greater than the length of the original slice.
|
|
///
|
|
/// Slicing from `self.len()` yields an empty slice.
|
|
#[unstable = "waiting on final error conventions"]
|
|
fn slice_from_mut(self, start: uint) -> &'a mut [T];
|
|
|
|
/// Deprecated: use `slice_to_mut`.
|
|
#[deprecated = "use slice_to_mut"]
|
|
fn mut_slice_to(self, end: uint) -> &'a mut [T] {
|
|
self.slice_to_mut(end)
|
|
}
|
|
|
|
/// Returns a mutable subslice from the start of the slice to `end`.
|
|
///
|
|
/// Fails when `end` is strictly greater than the length of the original slice.
|
|
///
|
|
/// Slicing to `0` yields an empty slice.
|
|
#[unstable = "waiting on final error conventions"]
|
|
fn slice_to_mut(self, end: uint) -> &'a mut [T];
|
|
|
|
/// Deprecated: use `iter_mut`.
|
|
#[deprecated = "use iter_mut"]
|
|
fn mut_iter(self) -> MutItems<'a, T> {
|
|
self.iter_mut()
|
|
}
|
|
|
|
/// Returns an iterator that allows modifying each value
|
|
#[unstable = "waiting on iterator type name conventions"]
|
|
fn iter_mut(self) -> MutItems<'a, T>;
|
|
|
|
/// Returns a mutable pointer to the first element of a slice, or `None` if it is empty
|
|
#[unstable = "name may change"]
|
|
fn head_mut(self) -> Option<&'a mut T>;
|
|
|
|
/// Returns all but the first element of a mutable slice
|
|
#[unstable = "name may change"]
|
|
fn tail_mut(self) -> &'a mut [T];
|
|
|
|
/// Returns all but the last element of a mutable slice
|
|
#[unstable = "name may change"]
|
|
fn init_mut(self) -> &'a mut [T];
|
|
|
|
/// Deprecated: use `last_mut`.
|
|
#[deprecated = "use last_mut"]
|
|
fn mut_last(self) -> Option<&'a mut T> {
|
|
self.last_mut()
|
|
}
|
|
|
|
/// Returns a mutable pointer to the last item in the slice.
|
|
#[unstable = "name may change"]
|
|
fn last_mut(self) -> Option<&'a mut T>;
|
|
|
|
/// Deprecated: use `split_mut`.
|
|
#[deprecated = "use split_mut"]
|
|
fn mut_split(self, pred: |&T|: 'a -> bool) -> MutSplits<'a, T> {
|
|
self.split_mut(pred)
|
|
}
|
|
|
|
/// Returns an iterator over mutable subslices separated by elements that
|
|
/// match `pred`. The matched element is not contained in the subslices.
|
|
#[unstable = "waiting on unboxed closures, iterator type name conventions"]
|
|
fn split_mut(self, pred: |&T|: 'a -> bool) -> MutSplits<'a, T>;
|
|
|
|
/// Returns an iterator over subslices separated by elements that match
|
|
/// `pred`, limited to splitting at most `n` times. The matched element is
|
|
/// not contained in the subslices.
|
|
#[unstable = "waiting on unboxed closures, iterator type name conventions"]
|
|
fn splitn_mut(self, n: uint, pred: |&T|: 'a -> bool) -> SplitsN<MutSplits<'a, T>>;
|
|
|
|
/// Returns an iterator over subslices separated by elements that match
|
|
/// `pred` limited to splitting at most `n` times. This starts at the end of
|
|
/// the slice and works backwards. The matched element is not contained in
|
|
/// the subslices.
|
|
#[unstable = "waiting on unboxed closures, iterator type name conventions"]
|
|
fn rsplitn_mut(self, n: uint, pred: |&T|: 'a -> bool) -> SplitsN<MutSplits<'a, T>>;
|
|
|
|
/// Deprecated: use `chunks_mut`.
|
|
#[deprecated = "use chunks_mut"]
|
|
fn mut_chunks(self, chunk_size: uint) -> MutChunks<'a, T> {
|
|
self.chunks_mut(chunk_size)
|
|
}
|
|
|
|
/// Returns an iterator over `chunk_size` elements of the slice at a time.
|
|
/// The chunks are mutable and do not overlap. If `chunk_size` does
|
|
/// not divide the length of the slice, then the last chunk will not
|
|
/// have length `chunk_size`.
|
|
///
|
|
/// # Failure
|
|
///
|
|
/// Fails if `chunk_size` is 0.
|
|
#[unstable = "waiting on iterator type name conventions"]
|
|
fn chunks_mut(self, chunk_size: uint) -> MutChunks<'a, T>;
|
|
|
|
/**
|
|
* Returns a mutable reference to the first element in this slice
|
|
* and adjusts the slice in place so that it no longer contains
|
|
* that element. O(1).
|
|
*
|
|
* Equivalent to:
|
|
*
|
|
* ```ignore
|
|
* if self.len() == 0 { return None; }
|
|
* let head = &mut self[0];
|
|
* *self = self.slice_from_mut(1);
|
|
* Some(head)
|
|
* ```
|
|
*
|
|
* Returns `None` if slice is empty
|
|
*/
|
|
#[deprecated = "use iter_mut"]
|
|
fn mut_shift_ref(&mut self) -> Option<&'a mut T>;
|
|
|
|
/**
|
|
* Returns a mutable reference to the last element in this slice
|
|
* and adjusts the slice in place so that it no longer contains
|
|
* that element. O(1).
|
|
*
|
|
* Equivalent to:
|
|
*
|
|
* ```ignore
|
|
* if self.len() == 0 { return None; }
|
|
* let tail = &mut self[self.len() - 1];
|
|
* *self = self.slice_to_mut(self.len() - 1);
|
|
* Some(tail)
|
|
* ```
|
|
*
|
|
* Returns `None` if slice is empty.
|
|
*/
|
|
#[deprecated = "use iter_mut"]
|
|
fn mut_pop_ref(&mut self) -> Option<&'a mut T>;
|
|
|
|
/// Swaps two elements in a slice.
|
|
///
|
|
/// Fails if `a` or `b` are out of bounds.
|
|
///
|
|
/// # Arguments
|
|
///
|
|
/// * a - The index of the first element
|
|
/// * b - The index of the second element
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```rust
|
|
/// let mut v = ["a", "b", "c", "d"];
|
|
/// v.swap(1, 3);
|
|
/// assert!(v == ["a", "d", "c", "b"]);
|
|
/// ```
|
|
#[unstable = "waiting on final error conventions"]
|
|
fn swap(self, a: uint, b: uint);
|
|
|
|
/// Deprecated: use `split_at_mut`.
|
|
#[deprecated = "use split_at_mut"]
|
|
fn mut_split_at(self, mid: uint) -> (&'a mut [T], &'a mut [T]) {
|
|
self.split_at_mut(mid)
|
|
}
|
|
|
|
/// Divides one `&mut` into two at an index.
|
|
///
|
|
/// The first will contain all indices from `[0, mid)` (excluding
|
|
/// the index `mid` itself) and the second will contain all
|
|
/// indices from `[mid, len)` (excluding the index `len` itself).
|
|
///
|
|
/// Fails if `mid > len`.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```rust
|
|
/// let mut v = [1i, 2, 3, 4, 5, 6];
|
|
///
|
|
/// // scoped to restrict the lifetime of the borrows
|
|
/// {
|
|
/// let (left, right) = v.split_at_mut(0);
|
|
/// assert!(left == &mut []);
|
|
/// assert!(right == &mut [1i, 2, 3, 4, 5, 6]);
|
|
/// }
|
|
///
|
|
/// {
|
|
/// let (left, right) = v.split_at_mut(2);
|
|
/// assert!(left == &mut [1i, 2]);
|
|
/// assert!(right == &mut [3i, 4, 5, 6]);
|
|
/// }
|
|
///
|
|
/// {
|
|
/// let (left, right) = v.split_at_mut(6);
|
|
/// assert!(left == &mut [1i, 2, 3, 4, 5, 6]);
|
|
/// assert!(right == &mut []);
|
|
/// }
|
|
/// ```
|
|
#[unstable = "waiting on final error conventions"]
|
|
fn split_at_mut(self, mid: uint) -> (&'a mut [T], &'a mut [T]);
|
|
|
|
/// Reverse the order of elements in a slice, in place.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```rust
|
|
/// let mut v = [1i, 2, 3];
|
|
/// v.reverse();
|
|
/// assert!(v == [3i, 2, 1]);
|
|
/// ```
|
|
#[experimental = "may be moved to iterators instead"]
|
|
fn reverse(self);
|
|
|
|
/// Deprecated: use `unsafe_mut`.
|
|
#[deprecated = "use unsafe_mut"]
|
|
unsafe fn unsafe_mut_ref(self, index: uint) -> &'a mut T {
|
|
self.unsafe_mut(index)
|
|
}
|
|
|
|
/// Returns an unsafe mutable pointer to the element in index
|
|
#[experimental = "waiting on unsafe conventions"]
|
|
unsafe fn unsafe_mut(self, index: uint) -> &'a mut T;
|
|
|
|
/// Return an unsafe mutable pointer to the slice's buffer.
|
|
///
|
|
/// The caller must ensure that the slice outlives the pointer this
|
|
/// function returns, or else it will end up pointing to garbage.
|
|
///
|
|
/// Modifying the slice may cause its buffer to be reallocated, which
|
|
/// would also make any pointers to it invalid.
|
|
#[inline]
|
|
#[unstable]
|
|
fn as_mut_ptr(self) -> *mut T;
|
|
|
|
/// Deprecated: use `*foo.as_mut_ptr().offset(index) = val` instead.
|
|
#[deprecated = "use `*foo.as_mut_ptr().offset(index) = val`"]
|
|
unsafe fn unsafe_set(self, index: uint, val: T);
|
|
|
|
/// Deprecated: use `ptr::write(foo.as_mut_ptr().offset(i), val)` instead.
|
|
#[deprecated = "use `ptr::write(foo.as_mut_ptr().offset(i), val)`"]
|
|
unsafe fn init_elem(self, i: uint, val: T);
|
|
|
|
/// Deprecated: use `as_mut_ptr` and `ptr::copy_memory` instead.
|
|
#[deprecated = "use as_mut_ptr and ptr::copy_memory"]
|
|
unsafe fn copy_memory(self, src: &[T]);
|
|
}
|
|
|
|
#[experimental = "trait is experimental"]
|
|
impl<'a,T> MutableSlice<'a, T> for &'a mut [T] {
|
|
#[inline]
|
|
fn get_mut(self, index: uint) -> Option<&'a mut T> {
|
|
if index < self.len() { Some(&mut self[index]) } else { None }
|
|
}
|
|
|
|
#[inline]
|
|
fn as_mut_slice(self) -> &'a mut [T] { self }
|
|
|
|
fn slice_mut(self, start: uint, end: uint) -> &'a mut [T] {
|
|
assert!(start <= end);
|
|
assert!(end <= self.len());
|
|
unsafe {
|
|
transmute(RawSlice {
|
|
data: self.as_mut_ptr().offset(start as int) as *const T,
|
|
len: (end - start)
|
|
})
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn slice_from_mut(self, start: uint) -> &'a mut [T] {
|
|
let len = self.len();
|
|
self.slice_mut(start, len)
|
|
}
|
|
|
|
#[inline]
|
|
fn slice_to_mut(self, end: uint) -> &'a mut [T] {
|
|
self.slice_mut(0, end)
|
|
}
|
|
|
|
#[inline]
|
|
fn split_at_mut(self, mid: uint) -> (&'a mut [T], &'a mut [T]) {
|
|
unsafe {
|
|
let len = self.len();
|
|
let self2: &'a mut [T] = mem::transmute_copy(&self);
|
|
(self.slice_mut(0, mid), self2.slice_mut(mid, len))
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn iter_mut(self) -> MutItems<'a, T> {
|
|
unsafe {
|
|
let p = self.as_mut_ptr();
|
|
if mem::size_of::<T>() == 0 {
|
|
MutItems{ptr: p,
|
|
end: (p as uint + self.len()) as *mut T,
|
|
marker: marker::ContravariantLifetime::<'a>,
|
|
marker2: marker::NoCopy}
|
|
} else {
|
|
MutItems{ptr: p,
|
|
end: p.offset(self.len() as int),
|
|
marker: marker::ContravariantLifetime::<'a>,
|
|
marker2: marker::NoCopy}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn last_mut(self) -> Option<&'a mut T> {
|
|
let len = self.len();
|
|
if len == 0 { return None; }
|
|
Some(&mut self[len - 1])
|
|
}
|
|
|
|
#[inline]
|
|
fn head_mut(self) -> Option<&'a mut T> {
|
|
if self.len() == 0 { None } else { Some(&mut self[0]) }
|
|
}
|
|
|
|
#[inline]
|
|
fn tail_mut(self) -> &'a mut [T] {
|
|
let len = self.len();
|
|
self.slice_mut(1, len)
|
|
}
|
|
|
|
#[inline]
|
|
fn init_mut(self) -> &'a mut [T] {
|
|
let len = self.len();
|
|
self.slice_mut(0, len - 1)
|
|
}
|
|
|
|
#[inline]
|
|
fn split_mut(self, pred: |&T|: 'a -> bool) -> MutSplits<'a, T> {
|
|
MutSplits { v: self, pred: pred, finished: false }
|
|
}
|
|
|
|
#[inline]
|
|
fn splitn_mut(self, n: uint, pred: |&T|: 'a -> bool) -> SplitsN<MutSplits<'a, T>> {
|
|
SplitsN {
|
|
iter: self.split_mut(pred),
|
|
count: n,
|
|
invert: false
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn rsplitn_mut(self, n: uint, pred: |&T|: 'a -> bool) -> SplitsN<MutSplits<'a, T>> {
|
|
SplitsN {
|
|
iter: self.split_mut(pred),
|
|
count: n,
|
|
invert: true
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn chunks_mut(self, chunk_size: uint) -> MutChunks<'a, T> {
|
|
assert!(chunk_size > 0);
|
|
MutChunks { v: self, chunk_size: chunk_size }
|
|
}
|
|
|
|
fn mut_shift_ref(&mut self) -> Option<&'a mut T> {
|
|
unsafe {
|
|
let s: &mut RawSlice<T> = transmute(self);
|
|
match raw::shift_ptr(s) {
|
|
// FIXME #13933: this `&` -> `&mut` cast is a little
|
|
// dubious
|
|
Some(p) => Some(&mut *(p as *mut _)),
|
|
None => None,
|
|
}
|
|
}
|
|
}
|
|
|
|
fn mut_pop_ref(&mut self) -> Option<&'a mut T> {
|
|
unsafe {
|
|
let s: &mut RawSlice<T> = transmute(self);
|
|
match raw::pop_ptr(s) {
|
|
// FIXME #13933: this `&` -> `&mut` cast is a little
|
|
// dubious
|
|
Some(p) => Some(&mut *(p as *mut _)),
|
|
None => None,
|
|
}
|
|
}
|
|
}
|
|
|
|
fn swap(self, a: uint, b: uint) {
|
|
unsafe {
|
|
// Can't take two mutable loans from one vector, so instead just cast
|
|
// them to their raw pointers to do the swap
|
|
let pa: *mut T = &mut self[a];
|
|
let pb: *mut T = &mut self[b];
|
|
ptr::swap(pa, pb);
|
|
}
|
|
}
|
|
|
|
fn reverse(self) {
|
|
let mut i: uint = 0;
|
|
let ln = self.len();
|
|
while i < ln / 2 {
|
|
// Unsafe swap to avoid the bounds check in safe swap.
|
|
unsafe {
|
|
let pa: *mut T = self.unsafe_mut(i);
|
|
let pb: *mut T = self.unsafe_mut(ln - i - 1);
|
|
ptr::swap(pa, pb);
|
|
}
|
|
i += 1;
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
unsafe fn unsafe_mut(self, index: uint) -> &'a mut T {
|
|
transmute((self.repr().data as *mut T).offset(index as int))
|
|
}
|
|
|
|
#[inline]
|
|
fn as_mut_ptr(self) -> *mut T {
|
|
self.repr().data as *mut T
|
|
}
|
|
|
|
#[inline]
|
|
unsafe fn unsafe_set(self, index: uint, val: T) {
|
|
*self.unsafe_mut(index) = val;
|
|
}
|
|
|
|
#[inline]
|
|
unsafe fn init_elem(self, i: uint, val: T) {
|
|
ptr::write(&mut (*self.as_mut_ptr().offset(i as int)), val);
|
|
}
|
|
|
|
#[inline]
|
|
unsafe fn copy_memory(self, src: &[T]) {
|
|
let len_src = src.len();
|
|
assert!(self.len() >= len_src);
|
|
ptr::copy_nonoverlapping_memory(self.as_mut_ptr(), src.as_ptr(), len_src)
|
|
}
|
|
}
|
|
|
|
/// Extension methods for slices containing `PartialEq` elements.
|
|
#[unstable = "may merge with other traits"]
|
|
pub trait ImmutablePartialEqSlice<T:PartialEq> {
|
|
/// Find the first index containing a matching value.
|
|
fn position_elem(&self, t: &T) -> Option<uint>;
|
|
|
|
/// Find the last index containing a matching value.
|
|
fn rposition_elem(&self, t: &T) -> Option<uint>;
|
|
|
|
/// Return true if the slice contains an element with the given value.
|
|
fn contains(&self, x: &T) -> bool;
|
|
|
|
/// Returns true if `needle` is a prefix of the slice.
|
|
fn starts_with(&self, needle: &[T]) -> bool;
|
|
|
|
/// Returns true if `needle` is a suffix of the slice.
|
|
fn ends_with(&self, needle: &[T]) -> bool;
|
|
}
|
|
|
|
#[unstable = "trait is unstable"]
|
|
impl<'a,T:PartialEq> ImmutablePartialEqSlice<T> for &'a [T] {
|
|
#[inline]
|
|
fn position_elem(&self, x: &T) -> Option<uint> {
|
|
self.iter().position(|y| *x == *y)
|
|
}
|
|
|
|
#[inline]
|
|
fn rposition_elem(&self, t: &T) -> Option<uint> {
|
|
self.iter().rposition(|x| *x == *t)
|
|
}
|
|
|
|
#[inline]
|
|
fn contains(&self, x: &T) -> bool {
|
|
self.iter().any(|elt| *x == *elt)
|
|
}
|
|
|
|
#[inline]
|
|
fn starts_with(&self, needle: &[T]) -> bool {
|
|
let n = needle.len();
|
|
self.len() >= n && needle == self.slice_to(n)
|
|
}
|
|
|
|
#[inline]
|
|
fn ends_with(&self, needle: &[T]) -> bool {
|
|
let (m, n) = (self.len(), needle.len());
|
|
m >= n && needle == self.slice_from(m - n)
|
|
}
|
|
}
|
|
|
|
/// Extension methods for slices containing `Ord` elements.
|
|
#[unstable = "may merge with other traits"]
|
|
pub trait ImmutableOrdSlice<T: Ord> {
|
|
/// Deprecated: use `binary_search_elem`.
|
|
#[deprecated = "use binary_search_elem"]
|
|
fn bsearch_elem(&self, x: &T) -> Option<uint>;
|
|
|
|
/// Binary search a sorted slice for a given element.
|
|
///
|
|
/// If the value is found then `Found` is returned, containing the
|
|
/// index of the matching element; if the value is not found then
|
|
/// `NotFound` is returned, containing the index where a matching
|
|
/// element could be inserted while maintaining sorted order.
|
|
#[unstable = "name likely to change"]
|
|
fn binary_search_elem(&self, x: &T) -> BinarySearchResult;
|
|
}
|
|
|
|
#[unstable = "trait is unstable"]
|
|
impl<'a, T: Ord> ImmutableOrdSlice<T> for &'a [T] {
|
|
#[deprecated = "use binary_search_elem"]
|
|
#[allow(deprecated)]
|
|
fn bsearch_elem(&self, x: &T) -> Option<uint> {
|
|
self.bsearch(|p| p.cmp(x))
|
|
}
|
|
|
|
#[unstable]
|
|
fn binary_search_elem(&self, x: &T) -> BinarySearchResult {
|
|
self.binary_search(|p| p.cmp(x))
|
|
}
|
|
}
|
|
|
|
/// Trait for &[T] where T is Cloneable
|
|
#[unstable = "may merge with other traits"]
|
|
pub trait MutableCloneableSlice<T> {
|
|
/// Copies as many elements from `src` as it can into `self` (the
|
|
/// shorter of `self.len()` and `src.len()`). Returns the number
|
|
/// of elements copied.
|
|
#[deprecated = "renamed to clone_from_slice"]
|
|
fn copy_from(self, s: &[T]) -> uint { self.clone_from_slice(s) }
|
|
|
|
/// Copies as many elements from `src` as it can into `self` (the
|
|
/// shorter of `self.len()` and `src.len()`). Returns the number
|
|
/// of elements copied.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```rust
|
|
/// use std::slice::MutableCloneableSlice;
|
|
///
|
|
/// let mut dst = [0i, 0, 0];
|
|
/// let src = [1i, 2];
|
|
///
|
|
/// assert!(dst.clone_from_slice(src) == 2);
|
|
/// assert!(dst == [1, 2, 0]);
|
|
///
|
|
/// let src2 = [3i, 4, 5, 6];
|
|
/// assert!(dst.clone_from_slice(src2) == 3);
|
|
/// assert!(dst == [3i, 4, 5]);
|
|
/// ```
|
|
fn clone_from_slice(self, &[T]) -> uint;
|
|
}
|
|
|
|
#[unstable = "trait is unstable"]
|
|
impl<'a, T:Clone> MutableCloneableSlice<T> for &'a mut [T] {
|
|
#[inline]
|
|
fn clone_from_slice(self, src: &[T]) -> uint {
|
|
for (a, b) in self.iter_mut().zip(src.iter()) {
|
|
a.clone_from(b);
|
|
}
|
|
cmp::min(self.len(), src.len())
|
|
}
|
|
}
|
|
|
|
|
|
|
|
|
|
//
|
|
// Common traits
|
|
//
|
|
|
|
/// Data that is viewable as a slice.
|
|
#[unstable = "may merge with other traits"]
|
|
pub trait Slice<T> {
|
|
/// Work with `self` as a slice.
|
|
fn as_slice<'a>(&'a self) -> &'a [T];
|
|
}
|
|
|
|
#[unstable = "trait is unstable"]
|
|
impl<'a,T> Slice<T> for &'a [T] {
|
|
#[inline(always)]
|
|
fn as_slice<'a>(&'a self) -> &'a [T] { *self }
|
|
}
|
|
|
|
#[experimental = "trait is experimental"]
|
|
impl<'a, T> Collection for &'a [T] {
|
|
/// Returns the length of a slice.
|
|
#[inline]
|
|
fn len(&self) -> uint {
|
|
self.repr().len
|
|
}
|
|
}
|
|
|
|
#[experimental = "trait is experimental"]
|
|
impl<'a, T> Collection for &'a mut [T] {
|
|
/// Returns the length of a slice.
|
|
#[inline]
|
|
fn len(&self) -> uint {
|
|
self.repr().len
|
|
}
|
|
}
|
|
|
|
#[unstable = "waiting for DST"]
|
|
impl<'a, T> Default for &'a [T] {
|
|
fn default() -> &'a [T] { &[] }
|
|
}
|
|
|
|
//
|
|
// Iterators
|
|
//
|
|
|
|
// The shared definition of the `Item` and `MutItems` iterators
|
|
macro_rules! iterator {
|
|
(struct $name:ident -> $ptr:ty, $elem:ty) => {
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> Iterator<$elem> for $name<'a, T> {
|
|
#[inline]
|
|
fn next(&mut self) -> Option<$elem> {
|
|
// could be implemented with slices, but this avoids bounds checks
|
|
unsafe {
|
|
if self.ptr == self.end {
|
|
None
|
|
} else {
|
|
if mem::size_of::<T>() == 0 {
|
|
// purposefully don't use 'ptr.offset' because for
|
|
// vectors with 0-size elements this would return the
|
|
// same pointer.
|
|
self.ptr = transmute(self.ptr as uint + 1);
|
|
|
|
// Use a non-null pointer value
|
|
Some(transmute(1u))
|
|
} else {
|
|
let old = self.ptr;
|
|
self.ptr = self.ptr.offset(1);
|
|
|
|
Some(transmute(old))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn size_hint(&self) -> (uint, Option<uint>) {
|
|
let diff = (self.end as uint) - (self.ptr as uint);
|
|
let size = mem::size_of::<T>();
|
|
let exact = diff / (if size == 0 {1} else {size});
|
|
(exact, Some(exact))
|
|
}
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> DoubleEndedIterator<$elem> for $name<'a, T> {
|
|
#[inline]
|
|
fn next_back(&mut self) -> Option<$elem> {
|
|
// could be implemented with slices, but this avoids bounds checks
|
|
unsafe {
|
|
if self.end == self.ptr {
|
|
None
|
|
} else {
|
|
if mem::size_of::<T>() == 0 {
|
|
// See above for why 'ptr.offset' isn't used
|
|
self.end = transmute(self.end as uint - 1);
|
|
|
|
// Use a non-null pointer value
|
|
Some(transmute(1u))
|
|
} else {
|
|
self.end = self.end.offset(-1);
|
|
|
|
Some(transmute(self.end))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Immutable slice iterator
|
|
#[experimental = "needs review"]
|
|
pub struct Items<'a, T> {
|
|
ptr: *const T,
|
|
end: *const T,
|
|
marker: marker::ContravariantLifetime<'a>
|
|
}
|
|
|
|
iterator!{struct Items -> *const T, &'a T}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> ExactSize<&'a T> for Items<'a, T> {}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> Clone for Items<'a, T> {
|
|
fn clone(&self) -> Items<'a, T> { *self }
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> RandomAccessIterator<&'a T> for Items<'a, T> {
|
|
#[inline]
|
|
fn indexable(&self) -> uint {
|
|
let (exact, _) = self.size_hint();
|
|
exact
|
|
}
|
|
|
|
#[inline]
|
|
fn idx(&mut self, index: uint) -> Option<&'a T> {
|
|
unsafe {
|
|
if index < self.indexable() {
|
|
if mem::size_of::<T>() == 0 {
|
|
// Use a non-null pointer value
|
|
Some(transmute(1u))
|
|
} else {
|
|
Some(transmute(self.ptr.offset(index as int)))
|
|
}
|
|
} else {
|
|
None
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Mutable slice iterator.
|
|
#[experimental = "needs review"]
|
|
pub struct MutItems<'a, T> {
|
|
ptr: *mut T,
|
|
end: *mut T,
|
|
marker: marker::ContravariantLifetime<'a>,
|
|
marker2: marker::NoCopy
|
|
}
|
|
|
|
iterator!{struct MutItems -> *mut T, &'a mut T}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> ExactSize<&'a mut T> for MutItems<'a, T> {}
|
|
|
|
/// An abstraction over the splitting iterators, so that splitn, splitn_mut etc
|
|
/// can be implemented once.
|
|
trait SplitsIter<E>: DoubleEndedIterator<E> {
|
|
/// Mark the underlying iterator as complete, extracting the remaining
|
|
/// portion of the slice.
|
|
fn finish(&mut self) -> Option<E>;
|
|
}
|
|
|
|
/// An iterator over subslices separated by elements that match a predicate
|
|
/// function.
|
|
#[experimental = "needs review"]
|
|
pub struct Splits<'a, T:'a> {
|
|
v: &'a [T],
|
|
pred: |t: &T|: 'a -> bool,
|
|
finished: bool
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> Iterator<&'a [T]> for Splits<'a, T> {
|
|
#[inline]
|
|
fn next(&mut self) -> Option<&'a [T]> {
|
|
if self.finished { return None; }
|
|
|
|
match self.v.iter().position(|x| (self.pred)(x)) {
|
|
None => self.finish(),
|
|
Some(idx) => {
|
|
let ret = Some(self.v.slice(0, idx));
|
|
self.v = self.v.slice(idx + 1, self.v.len());
|
|
ret
|
|
}
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn size_hint(&self) -> (uint, Option<uint>) {
|
|
if self.finished {
|
|
(0, Some(0))
|
|
} else {
|
|
(1, Some(self.v.len() + 1))
|
|
}
|
|
}
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> DoubleEndedIterator<&'a [T]> for Splits<'a, T> {
|
|
#[inline]
|
|
fn next_back(&mut self) -> Option<&'a [T]> {
|
|
if self.finished { return None; }
|
|
|
|
match self.v.iter().rposition(|x| (self.pred)(x)) {
|
|
None => self.finish(),
|
|
Some(idx) => {
|
|
let ret = Some(self.v.slice(idx + 1, self.v.len()));
|
|
self.v = self.v.slice(0, idx);
|
|
ret
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'a, T> SplitsIter<&'a [T]> for Splits<'a, T> {
|
|
#[inline]
|
|
fn finish(&mut self) -> Option<&'a [T]> {
|
|
if self.finished { None } else { self.finished = true; Some(self.v) }
|
|
}
|
|
}
|
|
|
|
/// An iterator over the subslices of the vector which are separated
|
|
/// by elements that match `pred`.
|
|
#[experimental = "needs review"]
|
|
pub struct MutSplits<'a, T:'a> {
|
|
v: &'a mut [T],
|
|
pred: |t: &T|: 'a -> bool,
|
|
finished: bool
|
|
}
|
|
|
|
impl<'a, T> SplitsIter<&'a mut [T]> for MutSplits<'a, T> {
|
|
#[inline]
|
|
fn finish(&mut self) -> Option<&'a mut [T]> {
|
|
if self.finished {
|
|
None
|
|
} else {
|
|
self.finished = true;
|
|
Some(mem::replace(&mut self.v, &mut []))
|
|
}
|
|
}
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> Iterator<&'a mut [T]> for MutSplits<'a, T> {
|
|
#[inline]
|
|
fn next(&mut self) -> Option<&'a mut [T]> {
|
|
if self.finished { return None; }
|
|
|
|
let idx_opt = { // work around borrowck limitations
|
|
let pred = &mut self.pred;
|
|
self.v.iter().position(|x| (*pred)(x))
|
|
};
|
|
match idx_opt {
|
|
None => self.finish(),
|
|
Some(idx) => {
|
|
let tmp = mem::replace(&mut self.v, &mut []);
|
|
let (head, tail) = tmp.split_at_mut(idx);
|
|
self.v = tail.slice_from_mut(1);
|
|
Some(head)
|
|
}
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn size_hint(&self) -> (uint, Option<uint>) {
|
|
if self.finished {
|
|
(0, Some(0))
|
|
} else {
|
|
// if the predicate doesn't match anything, we yield one slice
|
|
// if it matches every element, we yield len+1 empty slices.
|
|
(1, Some(self.v.len() + 1))
|
|
}
|
|
}
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> DoubleEndedIterator<&'a mut [T]> for MutSplits<'a, T> {
|
|
#[inline]
|
|
fn next_back(&mut self) -> Option<&'a mut [T]> {
|
|
if self.finished { return None; }
|
|
|
|
let idx_opt = { // work around borrowck limitations
|
|
let pred = &mut self.pred;
|
|
self.v.iter().rposition(|x| (*pred)(x))
|
|
};
|
|
match idx_opt {
|
|
None => self.finish(),
|
|
Some(idx) => {
|
|
let tmp = mem::replace(&mut self.v, &mut []);
|
|
let (head, tail) = tmp.split_at_mut(idx);
|
|
self.v = head;
|
|
Some(tail.slice_from_mut(1))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// An iterator over subslices separated by elements that match a predicate
|
|
/// function, splitting at most a fixed number of times.
|
|
#[experimental = "needs review"]
|
|
pub struct SplitsN<I> {
|
|
iter: I,
|
|
count: uint,
|
|
invert: bool
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<E, I: SplitsIter<E>> Iterator<E> for SplitsN<I> {
|
|
#[inline]
|
|
fn next(&mut self) -> Option<E> {
|
|
if self.count == 0 {
|
|
self.iter.finish()
|
|
} else {
|
|
self.count -= 1;
|
|
if self.invert { self.iter.next_back() } else { self.iter.next() }
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn size_hint(&self) -> (uint, Option<uint>) {
|
|
let (lower, upper_opt) = self.iter.size_hint();
|
|
(lower, upper_opt.map(|upper| cmp::min(self.count + 1, upper)))
|
|
}
|
|
}
|
|
|
|
/// An iterator over overlapping subslices of length `size`.
|
|
#[deriving(Clone)]
|
|
#[experimental = "needs review"]
|
|
pub struct Windows<'a, T:'a> {
|
|
v: &'a [T],
|
|
size: uint
|
|
}
|
|
|
|
impl<'a, T> Iterator<&'a [T]> for Windows<'a, T> {
|
|
#[inline]
|
|
fn next(&mut self) -> Option<&'a [T]> {
|
|
if self.size > self.v.len() {
|
|
None
|
|
} else {
|
|
let ret = Some(self.v.slice(0, self.size));
|
|
self.v = self.v.slice(1, self.v.len());
|
|
ret
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn size_hint(&self) -> (uint, Option<uint>) {
|
|
if self.size > self.v.len() {
|
|
(0, Some(0))
|
|
} else {
|
|
let x = self.v.len() - self.size;
|
|
(x.saturating_add(1), x.checked_add(&1u))
|
|
}
|
|
}
|
|
}
|
|
|
|
/// An iterator over a slice in (non-overlapping) chunks (`size` elements at a
|
|
/// time).
|
|
///
|
|
/// When the slice len is not evenly divided by the chunk size, the last slice
|
|
/// of the iteration will be the remainder.
|
|
#[deriving(Clone)]
|
|
#[experimental = "needs review"]
|
|
pub struct Chunks<'a, T:'a> {
|
|
v: &'a [T],
|
|
size: uint
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> Iterator<&'a [T]> for Chunks<'a, T> {
|
|
#[inline]
|
|
fn next(&mut self) -> Option<&'a [T]> {
|
|
if self.v.len() == 0 {
|
|
None
|
|
} else {
|
|
let chunksz = cmp::min(self.v.len(), self.size);
|
|
let (fst, snd) = self.v.split_at(chunksz);
|
|
self.v = snd;
|
|
Some(fst)
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn size_hint(&self) -> (uint, Option<uint>) {
|
|
if self.v.len() == 0 {
|
|
(0, Some(0))
|
|
} else {
|
|
let (n, rem) = div_rem(self.v.len(), self.size);
|
|
let n = if rem > 0 { n+1 } else { n };
|
|
(n, Some(n))
|
|
}
|
|
}
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> DoubleEndedIterator<&'a [T]> for Chunks<'a, T> {
|
|
#[inline]
|
|
fn next_back(&mut self) -> Option<&'a [T]> {
|
|
if self.v.len() == 0 {
|
|
None
|
|
} else {
|
|
let remainder = self.v.len() % self.size;
|
|
let chunksz = if remainder != 0 { remainder } else { self.size };
|
|
let (fst, snd) = self.v.split_at(self.v.len() - chunksz);
|
|
self.v = fst;
|
|
Some(snd)
|
|
}
|
|
}
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> RandomAccessIterator<&'a [T]> for Chunks<'a, T> {
|
|
#[inline]
|
|
fn indexable(&self) -> uint {
|
|
self.v.len()/self.size + if self.v.len() % self.size != 0 { 1 } else { 0 }
|
|
}
|
|
|
|
#[inline]
|
|
fn idx(&mut self, index: uint) -> Option<&'a [T]> {
|
|
if index < self.indexable() {
|
|
let lo = index * self.size;
|
|
let mut hi = lo + self.size;
|
|
if hi < lo || hi > self.v.len() { hi = self.v.len(); }
|
|
|
|
Some(self.v.slice(lo, hi))
|
|
} else {
|
|
None
|
|
}
|
|
}
|
|
}
|
|
|
|
/// An iterator over a slice in (non-overlapping) mutable chunks (`size`
|
|
/// elements at a time). When the slice len is not evenly divided by the chunk
|
|
/// size, the last slice of the iteration will be the remainder.
|
|
#[experimental = "needs review"]
|
|
pub struct MutChunks<'a, T:'a> {
|
|
v: &'a mut [T],
|
|
chunk_size: uint
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> Iterator<&'a mut [T]> for MutChunks<'a, T> {
|
|
#[inline]
|
|
fn next(&mut self) -> Option<&'a mut [T]> {
|
|
if self.v.len() == 0 {
|
|
None
|
|
} else {
|
|
let sz = cmp::min(self.v.len(), self.chunk_size);
|
|
let tmp = mem::replace(&mut self.v, &mut []);
|
|
let (head, tail) = tmp.split_at_mut(sz);
|
|
self.v = tail;
|
|
Some(head)
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn size_hint(&self) -> (uint, Option<uint>) {
|
|
if self.v.len() == 0 {
|
|
(0, Some(0))
|
|
} else {
|
|
let (n, rem) = div_rem(self.v.len(), self.chunk_size);
|
|
let n = if rem > 0 { n + 1 } else { n };
|
|
(n, Some(n))
|
|
}
|
|
}
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl<'a, T> DoubleEndedIterator<&'a mut [T]> for MutChunks<'a, T> {
|
|
#[inline]
|
|
fn next_back(&mut self) -> Option<&'a mut [T]> {
|
|
if self.v.len() == 0 {
|
|
None
|
|
} else {
|
|
let remainder = self.v.len() % self.chunk_size;
|
|
let sz = if remainder != 0 { remainder } else { self.chunk_size };
|
|
let tmp = mem::replace(&mut self.v, &mut []);
|
|
let tmp_len = tmp.len();
|
|
let (head, tail) = tmp.split_at_mut(tmp_len - sz);
|
|
self.v = head;
|
|
Some(tail)
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
|
|
/// The result of calling `binary_search`.
|
|
///
|
|
/// `Found` means the search succeeded, and the contained value is the
|
|
/// index of the matching element. `NotFound` means the search
|
|
/// succeeded, and the contained value is an index where a matching
|
|
/// value could be inserted while maintaining sort order.
|
|
#[deriving(PartialEq, Show)]
|
|
#[experimental = "needs review"]
|
|
pub enum BinarySearchResult {
|
|
/// The index of the found value.
|
|
Found(uint),
|
|
/// The index where the value should have been found.
|
|
NotFound(uint)
|
|
}
|
|
|
|
#[experimental = "needs review"]
|
|
impl BinarySearchResult {
|
|
/// Converts a `Found` to `Some`, `NotFound` to `None`.
|
|
/// Similar to `Result::ok`.
|
|
pub fn found(&self) -> Option<uint> {
|
|
match *self {
|
|
Found(i) => Some(i),
|
|
NotFound(_) => None
|
|
}
|
|
}
|
|
|
|
/// Convert a `Found` to `None`, `NotFound` to `Some`.
|
|
/// Similar to `Result::err`.
|
|
pub fn not_found(&self) -> Option<uint> {
|
|
match *self {
|
|
Found(_) => None,
|
|
NotFound(i) => Some(i)
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
|
|
//
|
|
// Free functions
|
|
//
|
|
|
|
/**
|
|
* Converts a pointer to A into a slice of length 1 (without copying).
|
|
*/
|
|
#[unstable = "waiting for DST"]
|
|
pub fn ref_slice<'a, A>(s: &'a A) -> &'a [A] {
|
|
unsafe {
|
|
transmute(RawSlice { data: s, len: 1 })
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Converts a pointer to A into a slice of length 1 (without copying).
|
|
*/
|
|
#[unstable = "waiting for DST"]
|
|
pub fn mut_ref_slice<'a, A>(s: &'a mut A) -> &'a mut [A] {
|
|
unsafe {
|
|
let ptr: *const A = transmute(s);
|
|
transmute(RawSlice { data: ptr, len: 1 })
|
|
}
|
|
}
|
|
|
|
|
|
|
|
|
|
//
|
|
// Submodules
|
|
//
|
|
|
|
/// Unsafe operations
|
|
#[experimental = "needs review"]
|
|
pub mod raw {
|
|
use mem::transmute;
|
|
use ptr::RawPtr;
|
|
use raw::Slice;
|
|
use option::{None, Option, Some};
|
|
|
|
/**
|
|
* Form a slice from a pointer and length (as a number of units,
|
|
* not bytes).
|
|
*/
|
|
#[inline]
|
|
pub unsafe fn buf_as_slice<T,U>(p: *const T, len: uint, f: |v: &[T]| -> U)
|
|
-> U {
|
|
f(transmute(Slice {
|
|
data: p,
|
|
len: len
|
|
}))
|
|
}
|
|
|
|
/**
|
|
* Form a slice from a pointer and length (as a number of units,
|
|
* not bytes).
|
|
*/
|
|
#[inline]
|
|
pub unsafe fn mut_buf_as_slice<T,
|
|
U>(
|
|
p: *mut T,
|
|
len: uint,
|
|
f: |v: &mut [T]| -> U)
|
|
-> U {
|
|
f(transmute(Slice {
|
|
data: p as *const T,
|
|
len: len
|
|
}))
|
|
}
|
|
|
|
/**
|
|
* Returns a pointer to first element in slice and adjusts
|
|
* slice so it no longer contains that element. Returns None
|
|
* if the slice is empty. O(1).
|
|
*/
|
|
#[inline]
|
|
pub unsafe fn shift_ptr<T>(slice: &mut Slice<T>) -> Option<*const T> {
|
|
if slice.len == 0 { return None; }
|
|
let head: *const T = slice.data;
|
|
slice.data = slice.data.offset(1);
|
|
slice.len -= 1;
|
|
Some(head)
|
|
}
|
|
|
|
/**
|
|
* Returns a pointer to last element in slice and adjusts
|
|
* slice so it no longer contains that element. Returns None
|
|
* if the slice is empty. O(1).
|
|
*/
|
|
#[inline]
|
|
pub unsafe fn pop_ptr<T>(slice: &mut Slice<T>) -> Option<*const T> {
|
|
if slice.len == 0 { return None; }
|
|
let tail: *const T = slice.data.offset((slice.len - 1) as int);
|
|
slice.len -= 1;
|
|
Some(tail)
|
|
}
|
|
}
|
|
|
|
/// Operations on `[u8]`.
|
|
#[experimental = "needs review"]
|
|
pub mod bytes {
|
|
use collections::Collection;
|
|
use ptr;
|
|
use slice::MutableSlice;
|
|
|
|
/// A trait for operations on mutable `[u8]`s.
|
|
pub trait MutableByteVector {
|
|
/// Sets all bytes of the receiver to the given value.
|
|
fn set_memory(self, value: u8);
|
|
}
|
|
|
|
impl<'a> MutableByteVector for &'a mut [u8] {
|
|
#[inline]
|
|
#[allow(experimental)]
|
|
fn set_memory(self, value: u8) {
|
|
unsafe { ptr::set_memory(self.as_mut_ptr(), value, self.len()) };
|
|
}
|
|
}
|
|
|
|
/// Copies data from `src` to `dst`
|
|
///
|
|
/// `src` and `dst` must not overlap. Fails if the length of `dst`
|
|
/// is less than the length of `src`.
|
|
#[inline]
|
|
#[allow(deprecated)]
|
|
pub fn copy_memory(dst: &mut [u8], src: &[u8]) {
|
|
// Bound checks are done at .copy_memory.
|
|
unsafe { dst.copy_memory(src) }
|
|
}
|
|
}
|
|
|
|
|
|
|
|
//
|
|
// Boilerplate traits
|
|
//
|
|
|
|
#[unstable = "waiting for DST"]
|
|
impl<'a,T:PartialEq> PartialEq for &'a [T] {
|
|
fn eq(&self, other: & &'a [T]) -> bool {
|
|
self.len() == other.len() &&
|
|
order::eq(self.iter(), other.iter())
|
|
}
|
|
fn ne(&self, other: & &'a [T]) -> bool {
|
|
self.len() != other.len() ||
|
|
order::ne(self.iter(), other.iter())
|
|
}
|
|
}
|
|
|
|
#[unstable = "waiting for DST"]
|
|
impl<'a,T:Eq> Eq for &'a [T] {}
|
|
|
|
#[unstable = "waiting for DST"]
|
|
impl<'a,T:PartialEq, V: Slice<T>> Equiv<V> for &'a [T] {
|
|
#[inline]
|
|
fn equiv(&self, other: &V) -> bool { self.as_slice() == other.as_slice() }
|
|
}
|
|
|
|
#[unstable = "waiting for DST"]
|
|
impl<'a,T:PartialEq> PartialEq for &'a mut [T] {
|
|
fn eq(&self, other: & &'a mut [T]) -> bool {
|
|
self.len() == other.len() &&
|
|
order::eq(self.iter(), other.iter())
|
|
}
|
|
fn ne(&self, other: & &'a mut [T]) -> bool {
|
|
self.len() != other.len() ||
|
|
order::ne(self.iter(), other.iter())
|
|
}
|
|
}
|
|
|
|
#[unstable = "waiting for DST"]
|
|
impl<'a,T:Eq> Eq for &'a mut [T] {}
|
|
|
|
#[unstable = "waiting for DST"]
|
|
impl<'a,T:PartialEq, V: Slice<T>> Equiv<V> for &'a mut [T] {
|
|
#[inline]
|
|
fn equiv(&self, other: &V) -> bool { self.as_slice() == other.as_slice() }
|
|
}
|
|
|
|
#[unstable = "waiting for DST"]
|
|
impl<'a,T:Ord> Ord for &'a [T] {
|
|
fn cmp(&self, other: & &'a [T]) -> Ordering {
|
|
order::cmp(self.iter(), other.iter())
|
|
}
|
|
}
|
|
|
|
#[unstable = "waiting for DST"]
|
|
impl<'a, T: PartialOrd> PartialOrd for &'a [T] {
|
|
#[inline]
|
|
fn partial_cmp(&self, other: &&'a [T]) -> Option<Ordering> {
|
|
order::partial_cmp(self.iter(), other.iter())
|
|
}
|
|
#[inline]
|
|
fn lt(&self, other: & &'a [T]) -> bool {
|
|
order::lt(self.iter(), other.iter())
|
|
}
|
|
#[inline]
|
|
fn le(&self, other: & &'a [T]) -> bool {
|
|
order::le(self.iter(), other.iter())
|
|
}
|
|
#[inline]
|
|
fn ge(&self, other: & &'a [T]) -> bool {
|
|
order::ge(self.iter(), other.iter())
|
|
}
|
|
#[inline]
|
|
fn gt(&self, other: & &'a [T]) -> bool {
|
|
order::gt(self.iter(), other.iter())
|
|
}
|
|
}
|