Module collections::sliceExperimental [-]  [+] [src]

Utilities for slice manipulation

The slice module contains useful code to help work with slice values. Slices are a view into a block of memory represented as a pointer and a length.

fn main() { // slicing a Vec let vec = vec!(1i, 2, 3); let int_slice = vec.as_slice(); // coercing an array to a slice let str_slice: &[&str] = &["one", "two", "three"]; }
// slicing a Vec
let vec = vec!(1i, 2, 3);
let int_slice = vec.as_slice();
// 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]. For example, you can mutate the block of memory that a mutable slice points to:

fn main() { let x: &mut[int] = &mut [1i, 2, 3]; x[1] = 7; assert_eq!(x[0], 1); assert_eq!(x[1], 7); assert_eq!(x[2], 3); }
let x: &mut[int] = &mut [1i, 2, 3];
x[1] = 7;
assert_eq!(x[0], 1);
assert_eq!(x[1], 7);
assert_eq!(x[2], 3);

Here are some of the things this module contains:

Structs

There are several structs that are useful for slices, such as Items, which represents iteration over a slice.

Traits

A number of traits add methods that allow you to accomplish tasks with slices, the most important being SlicePrelude. Other traits apply only to slices of elements satisfying certain bounds (like Ord).

An example is the slice method which enables slicing syntax [a..b] that returns an immutable "view" into a Vec or another slice from the index interval [a, b):

#![feature(slicing_syntax)] fn main() { let numbers = [0i, 1i, 2i]; let last_numbers = numbers[1..3]; // last_numbers is now &[1i, 2i] }
#![feature(slicing_syntax)]
fn main() {
    let numbers = [0i, 1i, 2i];
    let last_numbers = numbers[1..3];
    // last_numbers is now &[1i, 2i]
}

Implementations of other traits

There are several implementations of common traits for slices. Some examples include:

Iteration

The method iter() returns an iteration value for a slice. The iterator yields references to the slice's elements, so if the element type of the slice is int, the element type of the iterator is &int.

fn main() { let numbers = [0i, 1i, 2i]; for &x in numbers.iter() { println!("{} is a number!", x); } }
let numbers = [0i, 1i, 2i];
for &x in numbers.iter() {
    println!("{} is a number!", x);
}

Primitive Types

slice

Utilities for slice manipulation

Modules

bytes

Operations on [u8].

raw

Unsafe operations

Structs

Chunks

An iterator over a slice in (non-overlapping) chunks (size elements at a time).

ElementSwaps

An iterator that yields the element swaps needed to produce a sequence of all possible permutations for an indexed sequence of elements. Each permutation is only a single swap apart.

Items

Immutable slice iterator

MutChunks

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.

MutItems

Mutable slice iterator.

MutSplits

An iterator over the subslices of the vector which are separated by elements that match pred.

Permutations

An iterator that uses ElementSwaps to iterate through all possible permutations of a vector.

Splits

An iterator over subslices separated by elements that match a predicate function.

Traits

AsSlice

Data that is viewable as a slice.

BoxedSlicePrelude

Extension methods for boxed slices.

CloneSliceAllocPrelude

Allocating extension methods for slices containing Clone elements.

CloneSlicePrelude

Extension methods for slices on Clone elements

ImmutableIntSlice

Extension methods for immutable slices containing integers.

MutableIntSlice

Extension methods for mutable slices containing integers.

OrdSliceAllocPrelude

Allocating extension methods for slices on Ord values.

OrdSlicePrelude

Extension methods for slices containing Ord elements.

PartialEqSlicePrelude

Extension methods for slices containing PartialEq elements.

SliceAllocPrelude

Allocating extension methods for slices.

SlicePrelude

Extension methods for slices.

SlicePrelude

Extension methods for slices.

VectorVector

Functions

mut_ref_slice

Converts a pointer to A into a slice of length 1 (without copying).

ref_slice

Converts a pointer to A into a slice of length 1 (without copying).