Primitive Type slice [−]
A dynamically-sized view into a contiguous sequence, [T]
.
Slices are a view into a block of memory represented as a pointer and a length.
fn main() { // slicing a Vec let vec = vec![1, 2, 3]; let int_slice = &vec[..]; // coercing an array to a slice let str_slice: &[&str] = &["one", "two", "three"]; }// slicing a Vec let vec = vec![1, 2, 3]; let int_slice = &vec[..]; // coercing an array to a slice let str_slice: &[&str] = &["one", "two", "three"];
Slices are either mutable or shared. The shared slice type is &[T]
,
while the mutable slice type is &mut [T]
, where T
represents the element
type. For example, you can mutate the block of memory that a mutable slice
points to:
let x = &mut [1, 2, 3]; x[1] = 7; assert_eq!(x, &[1, 7, 3]);
Methods
impl<T> [T]
Allocating extension methods for slices.
fn len(&self) -> usize
1.0.0
Returns the number of elements in the slice.
Example
fn main() { let a = [1, 2, 3]; assert_eq!(a.len(), 3); }let a = [1, 2, 3]; assert_eq!(a.len(), 3);
fn is_empty(&self) -> bool
1.0.0
Returns true if the slice has a length of 0
Example
fn main() { let a = [1, 2, 3]; assert!(!a.is_empty()); }let a = [1, 2, 3]; assert!(!a.is_empty());
fn first(&self) -> Option<&T>
1.0.0
Returns the first element of a slice, or None
if it is empty.
Examples
fn main() { let v = [10, 40, 30]; assert_eq!(Some(&10), v.first()); let w: &[i32] = &[]; assert_eq!(None, w.first()); }let v = [10, 40, 30]; assert_eq!(Some(&10), v.first()); let w: &[i32] = &[]; assert_eq!(None, w.first());
fn first_mut(&mut self) -> Option<&mut T>
1.0.0
Returns a mutable pointer to the first element of a slice, or None
if it is empty
fn split_first(&self) -> Option<(&T, &[T])>
1.5.0
Returns the first and all the rest of the elements of a slice.
fn split_first_mut(&mut self) -> Option<(&mut T, &mut [T])>
1.5.0
Returns the first and all the rest of the elements of a slice.
fn split_last(&self) -> Option<(&T, &[T])>
1.5.0
Returns the last and all the rest of the elements of a slice.
fn split_last_mut(&mut self) -> Option<(&mut T, &mut [T])>
1.5.0
Returns the last and all the rest of the elements of a slice.
fn last(&self) -> Option<&T>
1.0.0
Returns the last element of a slice, or None
if it is empty.
Examples
fn main() { let v = [10, 40, 30]; assert_eq!(Some(&30), v.last()); let w: &[i32] = &[]; assert_eq!(None, w.last()); }let v = [10, 40, 30]; assert_eq!(Some(&30), v.last()); let w: &[i32] = &[]; assert_eq!(None, w.last());
fn last_mut(&mut self) -> Option<&mut T>
1.0.0
Returns a mutable pointer to the last item in the slice.
fn get(&self, index: usize) -> Option<&T>
1.0.0
Returns the element of a slice at the given index, or None
if the
index is out of bounds.
Examples
fn main() { let v = [10, 40, 30]; assert_eq!(Some(&40), v.get(1)); assert_eq!(None, v.get(3)); }let v = [10, 40, 30]; assert_eq!(Some(&40), v.get(1)); assert_eq!(None, v.get(3));
fn get_mut(&mut self, index: usize) -> Option<&mut T>
1.0.0
Returns a mutable reference to the element at the given index,
or None
if the index is out of bounds
unsafe fn get_unchecked(&self, index: usize) -> &T
1.0.0
Returns a pointer to the element at the given index, without doing bounds checking.
unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T
1.0.0
Returns an unsafe mutable pointer to the element in index
fn as_ptr(&self) -> *const T
1.0.0
Returns an raw 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.
fn as_mut_ptr(&mut self) -> *mut T
1.0.0
Returns 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.
fn swap(&mut self, a: usize, b: usize)
1.0.0
Swaps two elements in a slice.
Arguments
- a - The index of the first element
- b - The index of the second element
Panics
Panics if a
or b
are out of bounds.
Example
fn main() { let mut v = ["a", "b", "c", "d"]; v.swap(1, 3); assert!(v == ["a", "d", "c", "b"]); }let mut v = ["a", "b", "c", "d"]; v.swap(1, 3); assert!(v == ["a", "d", "c", "b"]);
fn reverse(&mut self)
1.0.0
Reverse the order of elements in a slice, in place.
Example
fn main() { let mut v = [1, 2, 3]; v.reverse(); assert!(v == [3, 2, 1]); }let mut v = [1, 2, 3]; v.reverse(); assert!(v == [3, 2, 1]);
fn iter(&self) -> Iter<T>
1.0.0
Returns an iterator over the slice.
fn iter_mut(&mut self) -> IterMut<T>
1.0.0
Returns an iterator that allows modifying each value
fn windows(&self, size: usize) -> Windows<T>
1.0.0
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.
Panics
Panics if size
is 0.
Example
Print the adjacent pairs of a slice (i.e. [1,2]
, [2,3]
,
[3,4]
):
let v = &[1, 2, 3, 4]; for win in v.windows(2) { println!("{:?}", win); }
fn chunks(&self, size: usize) -> Chunks<T>
1.0.0
Returns an iterator over size
elements of the slice at a
time. The chunks are slices and do not overlap. If size
does not divide the
length of the slice, then the last chunk will not have length
size
.
Panics
Panics if size
is 0.
Example
Print the slice two elements at a time (i.e. [1,2]
,
[3,4]
, [5]
):
let v = &[1, 2, 3, 4, 5]; for win in v.chunks(2) { println!("{:?}", win); }
fn chunks_mut(&mut self, chunk_size: usize) -> ChunksMut<T>
1.0.0
Returns an iterator over chunk_size
elements of the slice at a time.
The chunks are mutable slices, 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
.
Panics
Panics if chunk_size
is 0.
fn split_at(&self, mid: usize) -> (&[T], &[T])
1.0.0
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).
Panics
Panics if mid > len
.
Examples
fn main() { let v = [10, 40, 30, 20, 50]; let (v1, v2) = v.split_at(2); assert_eq!([10, 40], v1); assert_eq!([30, 20, 50], v2); }let v = [10, 40, 30, 20, 50]; let (v1, v2) = v.split_at(2); assert_eq!([10, 40], v1); assert_eq!([30, 20, 50], v2);
fn split_at_mut(&mut self, mid: usize) -> (&mut [T], &mut [T])
1.0.0
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).
Panics
Panics if mid > len
.
Example
fn main() { let mut v = [1, 2, 3, 4, 5, 6]; // scoped to restrict the lifetime of the borrows { let (left, right) = v.split_at_mut(0); assert!(left == []); assert!(right == [1, 2, 3, 4, 5, 6]); } { let (left, right) = v.split_at_mut(2); assert!(left == [1, 2]); assert!(right == [3, 4, 5, 6]); } { let (left, right) = v.split_at_mut(6); assert!(left == [1, 2, 3, 4, 5, 6]); assert!(right == []); } }let mut v = [1, 2, 3, 4, 5, 6]; // scoped to restrict the lifetime of the borrows { let (left, right) = v.split_at_mut(0); assert!(left == []); assert!(right == [1, 2, 3, 4, 5, 6]); } { let (left, right) = v.split_at_mut(2); assert!(left == [1, 2]); assert!(right == [3, 4, 5, 6]); } { let (left, right) = v.split_at_mut(6); assert!(left == [1, 2, 3, 4, 5, 6]); assert!(right == []); }
fn split<F>(&self, pred: F) -> Split<T, F> where F: FnMut(&T) -> bool
1.0.0
Returns an iterator over subslices separated by elements that match
pred
. The matched element is not contained in the subslices.
Examples
Print the slice split by numbers divisible by 3 (i.e. [10, 40]
,
[20]
, [50]
):
let v = [10, 40, 30, 20, 60, 50]; for group in v.split(|num| *num % 3 == 0) { println!("{:?}", group); }
fn split_mut<F>(&mut self, pred: F) -> SplitMut<T, F> where F: FnMut(&T) -> bool
1.0.0
Returns an iterator over mutable subslices separated by elements that
match pred
. The matched element is not contained in the subslices.
fn splitn<F>(&self, n: usize, pred: F) -> SplitN<T, F> where F: FnMut(&T) -> bool
1.0.0
Returns an iterator over subslices separated by elements that match
pred
, limited to returning at most n
items. The matched element is
not contained in the subslices.
The last element returned, if any, will contain the remainder of the slice.
Examples
Print the slice split once by numbers divisible by 3 (i.e. [10, 40]
,
[20, 60, 50]
):
let v = [10, 40, 30, 20, 60, 50]; for group in v.splitn(2, |num| *num % 3 == 0) { println!("{:?}", group); }
fn splitn_mut<F>(&mut self, n: usize, pred: F) -> SplitNMut<T, F> where F: FnMut(&T) -> bool
1.0.0
Returns an iterator over subslices separated by elements that match
pred
, limited to returning at most n
items. The matched element is
not contained in the subslices.
The last element returned, if any, will contain the remainder of the slice.
fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<T, F> where F: FnMut(&T) -> bool
1.0.0
Returns an iterator over subslices separated by elements that match
pred
limited to returning at most n
items. This starts at the end of
the slice and works backwards. The matched element is not contained in
the subslices.
The last element returned, if any, will contain the remainder of the slice.
Examples
Print the slice split once, starting from the end, by numbers divisible
by 3 (i.e. [50]
, [10, 40, 30, 20]
):
let v = [10, 40, 30, 20, 60, 50]; for group in v.rsplitn(2, |num| *num % 3 == 0) { println!("{:?}", group); }
fn rsplitn_mut<F>(&mut self, n: usize, pred: F) -> RSplitNMut<T, F> where F: FnMut(&T) -> bool
1.0.0
Returns an iterator over subslices separated by elements that match
pred
limited to returning at most n
items. This starts at the end of
the slice and works backwards. The matched element is not contained in
the subslices.
The last element returned, if any, will contain the remainder of the slice.
fn contains(&self, x: &T) -> bool where T: PartialEq<T>
1.0.0
Returns true if the slice contains an element with the given value.
Examples
fn main() { let v = [10, 40, 30]; assert!(v.contains(&30)); assert!(!v.contains(&50)); }let v = [10, 40, 30]; assert!(v.contains(&30)); assert!(!v.contains(&50));
fn starts_with(&self, needle: &[T]) -> bool where T: PartialEq<T>
1.0.0
Returns true if needle
is a prefix of the slice.
Examples
fn main() { let v = [10, 40, 30]; assert!(v.starts_with(&[10])); assert!(v.starts_with(&[10, 40])); assert!(!v.starts_with(&[50])); assert!(!v.starts_with(&[10, 50])); }let v = [10, 40, 30]; assert!(v.starts_with(&[10])); assert!(v.starts_with(&[10, 40])); assert!(!v.starts_with(&[50])); assert!(!v.starts_with(&[10, 50]));
fn ends_with(&self, needle: &[T]) -> bool where T: PartialEq<T>
1.0.0
Returns true if needle
is a suffix of the slice.
Examples
fn main() { let v = [10, 40, 30]; assert!(v.ends_with(&[30])); assert!(v.ends_with(&[40, 30])); assert!(!v.ends_with(&[50])); assert!(!v.ends_with(&[50, 30])); }let v = [10, 40, 30]; assert!(v.ends_with(&[30])); assert!(v.ends_with(&[40, 30])); assert!(!v.ends_with(&[50])); assert!(!v.ends_with(&[50, 30]));
fn binary_search(&self, x: &T) -> Result<usize, usize> where T: Ord
1.0.0
Binary search a sorted slice for a given element.
If the value is found then Ok
is returned, containing the
index of the matching element; if the value is not found then
Err
is returned, containing the index where a matching
element could be inserted while maintaining sorted order.
Example
Looks up a series of four elements. The first is found, with a
uniquely determined position; the second and third are not
found; the fourth could match any position in [1,4]
.
let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55]; assert_eq!(s.binary_search(&13), Ok(9)); assert_eq!(s.binary_search(&4), Err(7)); assert_eq!(s.binary_search(&100), Err(13)); let r = s.binary_search(&1); assert!(match r { Ok(1...4) => true, _ => false, });
fn binary_search_by<F>(&self, f: F) -> Result<usize, usize> where F: FnMut(&T) -> Ordering
1.0.0
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 a matching value is found then returns Ok
, containing
the index for the matched element; if no match is found then
Err
is returned, containing the index where a matching
element could be inserted while maintaining sorted order.
Example
Looks up a series of four elements. The first is found, with a
uniquely determined position; the second and third are not
found; the fourth could match any position in [1,4]
.
let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55]; let seek = 13; assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Ok(9)); let seek = 4; assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(7)); let seek = 100; assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(13)); let seek = 1; let r = s.binary_search_by(|probe| probe.cmp(&seek)); assert!(match r { Ok(1...4) => true, _ => false, });
fn binary_search_by_key<B, F>(&self, b: &B, f: F) -> Result<usize, usize> where F: FnMut(&T) -> B, B: Ord
Binary search a sorted slice with a key extraction function.
Assumes that the slice is sorted by the key, for instance with
sort_by_key
using the same key extraction function.
If a matching value is found then returns Ok
, containing the
index for the matched element; if no match is found then Err
is returned, containing the index where a matching element could
be inserted while maintaining sorted order.
Examples
Looks up a series of four elements in a slice of pairs sorted by
their second elements. The first is found, with a uniquely
determined position; the second and third are not found; the
fourth could match any position in [1,4]
.
#![feature(slice_binary_search_by_key)] let s = [(0, 0), (2, 1), (4, 1), (5, 1), (3, 1), (1, 2), (2, 3), (4, 5), (5, 8), (3, 13), (1, 21), (2, 34), (4, 55)]; assert_eq!(s.binary_search_by_key(&13, |&(a,b)| b), Ok(9)); assert_eq!(s.binary_search_by_key(&4, |&(a,b)| b), Err(7)); assert_eq!(s.binary_search_by_key(&100, |&(a,b)| b), Err(13)); let r = s.binary_search_by_key(&1, |&(a,b)| b); assert!(match r { Ok(1...4) => true, _ => false, });
fn sort(&mut self) where T: Ord
1.0.0
Sorts the slice, in place.
This is equivalent to self.sort_by(|a, b| a.cmp(b))
.
This is a stable sort.
Examples
fn main() { let mut v = [-5, 4, 1, -3, 2]; v.sort(); assert!(v == [-5, -3, 1, 2, 4]); }let mut v = [-5, 4, 1, -3, 2]; v.sort(); assert!(v == [-5, -3, 1, 2, 4]);
fn sort_by_key<B, F>(&mut self, f: F) where B: Ord, F: FnMut(&T) -> B
1.7.0
Sorts the slice, in place, using key
to extract a key by which to
order the sort by.
This sort is O(n log n)
worst-case and stable, but allocates
approximately 2 * n
, where n
is the length of self
.
This is a stable sort.
Examples
fn main() { let mut v = [-5i32, 4, 1, -3, 2]; v.sort_by_key(|k| k.abs()); assert!(v == [1, 2, -3, 4, -5]); }let mut v = [-5i32, 4, 1, -3, 2]; v.sort_by_key(|k| k.abs()); assert!(v == [1, 2, -3, 4, -5]);
fn sort_by<F>(&mut self, compare: F) where F: FnMut(&T, &T) -> Ordering
1.0.0
Sorts the slice, in place, using compare
to compare
elements.
This sort is O(n log n)
worst-case and stable, but allocates
approximately 2 * n
, where n
is the length of self
.
Examples
fn main() { let mut v = [5, 4, 1, 3, 2]; v.sort_by(|a, b| a.cmp(b)); assert!(v == [1, 2, 3, 4, 5]); // reverse sorting v.sort_by(|a, b| b.cmp(a)); assert!(v == [5, 4, 3, 2, 1]); }let mut v = [5, 4, 1, 3, 2]; v.sort_by(|a, b| a.cmp(b)); assert!(v == [1, 2, 3, 4, 5]); // reverse sorting v.sort_by(|a, b| b.cmp(a)); assert!(v == [5, 4, 3, 2, 1]);
fn clone_from_slice(&mut self, src: &[T]) where T: Clone
1.7.0
Copies the elements from src
into self
.
The length of this slice must be the same as the slice passed in.
Panics
This function will panic if the two slices have different lengths.
Example
fn main() { let mut dst = [0, 0, 0]; let src = [1, 2, 3]; dst.clone_from_slice(&src); assert!(dst == [1, 2, 3]); }let mut dst = [0, 0, 0]; let src = [1, 2, 3]; dst.clone_from_slice(&src); assert!(dst == [1, 2, 3]);
fn copy_from_slice(&mut self, src: &[T]) where T: Copy
1.9.0
Copies all elements from src
into self
, using a memcpy.
The length of src
must be the same as self
.
Panics
This function will panic if the two slices have different lengths.
Example
fn main() { let mut dst = [0, 0, 0]; let src = [1, 2, 3]; dst.copy_from_slice(&src); assert_eq!(src, dst); }let mut dst = [0, 0, 0]; let src = [1, 2, 3]; dst.copy_from_slice(&src); assert_eq!(src, dst);
fn to_vec(&self) -> Vec<T> where T: Clone
1.0.0
Copies self
into a new Vec
.
fn into_vec(self: Box<[T]>) -> Vec<T>
1.0.0
Converts self
into a vector without clones or allocation.
Trait Implementations
impl<T> Debug for [T] where T: Debug
1.0.0
impl<T> Hash for [T] where T: Hash
1.0.0
fn hash<H>(&self, state: &mut H) where H: Hasher
fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher
1.3.0
impl<'a, 'b> Pattern<'a> for &'b [char]
Searches for chars that are equal to any of the chars in the array
type Searcher = CharSliceSearcher<'a, 'b>
fn into_searcher(self, haystack: &'a str) -> CharSliceSearcher<'a, 'b>
fn is_contained_in(self, haystack: &'a str) -> bool
fn is_prefix_of(self, haystack: &'a str) -> bool
fn is_suffix_of(self, haystack: &'a str) -> bool where CharSliceSearcher<'a, 'b>: ReverseSearcher<'a>
impl<T> PartialOrd<[T]> for [T] where T: PartialOrd<T>
1.0.0
fn partial_cmp(&self, other: &[T]) -> Option<Ordering>
fn lt(&self, other: &Rhs) -> bool
1.0.0
fn le(&self, other: &Rhs) -> bool
1.0.0
fn gt(&self, other: &Rhs) -> bool
1.0.0
fn ge(&self, other: &Rhs) -> bool
1.0.0
impl<T> Ord for [T] where T: Ord
1.0.0
impl<T> Eq for [T] where T: Eq
1.0.0
impl<A, B> PartialEq<[B]> for [A] where A: PartialEq<B>
1.0.0
impl<'a, T> IntoIterator for &'a mut [T]
1.0.0
impl<'a, T> IntoIterator for &'a [T]
1.0.0
impl<'a, T> Default for &'a mut [T]
1.5.0
fn default() -> &'a mut [T]
impl<'a, T> Default for &'a [T]
1.0.0
impl<T> IndexMut<RangeToInclusive<usize>> for [T]
fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut [T]
impl<T> IndexMut<RangeInclusive<usize>> for [T]
fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut [T]
impl<T> IndexMut<RangeFull> for [T]
1.0.0
Implements mutable slicing with syntax &mut self[..]
.
Returns a slice of the whole slice. This operation can not panic.
Equivalent to &mut self[0 .. self.len()]
impl<T> IndexMut<RangeFrom<usize>> for [T]
1.0.0
Implements mutable slicing with syntax &mut self[begin ..]
.
Returns a slice of self from and including the index begin
until the end.
Equivalent to &mut self[begin .. self.len()]
impl<T> IndexMut<RangeTo<usize>> for [T]
1.0.0
Implements mutable slicing with syntax &mut self[.. end]
.
Returns a slice of self from the beginning until but not including
the index end
.
Equivalent to &mut self[0 .. end]
impl<T> IndexMut<Range<usize>> for [T]
1.0.0
Implements mutable slicing with syntax &mut self[begin .. end]
.
Returns a slice of self for the index range [begin
..end
).
This operation is O(1)
.
Panics
Requires that begin <= end
and end <= self.len()
,
otherwise slicing will panic.
impl<T> Index<RangeToInclusive<usize>> for [T]
impl<T> Index<RangeInclusive<usize>> for [T]
impl<T> Index<RangeFull> for [T]
1.0.0
Implements slicing with syntax &self[..]
.
Returns a slice of the whole slice. This operation can not panic.
Equivalent to &self[0 .. self.len()]
impl<T> Index<RangeFrom<usize>> for [T]
1.0.0
Implements slicing with syntax &self[begin ..]
.
Returns a slice of self from and including the index begin
until the end.
Equivalent to &self[begin .. self.len()]
impl<T> Index<RangeTo<usize>> for [T]
1.0.0
Implements slicing with syntax &self[.. end]
.
Returns a slice of self from the beginning until but not including
the index end
.
Equivalent to &self[0 .. end]
impl<T> Index<Range<usize>> for [T]
1.0.0
Implements slicing with syntax &self[begin .. end]
.
Returns a slice of self for the index range [begin
..end
).
This operation is O(1)
.
Panics
Requires that begin <= end
and end <= self.len()
,
otherwise slicing will panic.