<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `slice` mod in crate `std`.">
<meta name="keywords" content="rust, rustlang, rust-lang, slice">
<title>std::slice - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../dark.css">
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
<a href='../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Module slice</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>std</a></p><script>window.sidebarCurrent = {name: 'slice', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>std</a>::<wbr><a class="mod" href=''>slice</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a class='srclink' href='../../src/alloc/lib.rs.html#182' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A dynamically-sized view into a contiguous sequence, <code>[T]</code>.</p>
<p>Slices are a view into a block of memory represented as a pointer and a
length.</p>
<pre class="rust rust-example-rendered">
<span class="comment">// slicing a Vec</span>
<span class="kw">let</span> <span class="ident">vec</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
<span class="kw">let</span> <span class="ident">int_slice</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">vec</span>[..];
<span class="comment">// coercing an array to a slice</span>
<span class="kw">let</span> <span class="ident">str_slice</span>: <span class="kw-2">&</span>[<span class="kw-2">&</span><span class="ident">str</span>] <span class="op">=</span> <span class="kw-2">&</span>[<span class="string">"one"</span>, <span class="string">"two"</span>, <span class="string">"three"</span>];<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0A%2F%2F%20slicing%20a%20Vec%0Alet%20vec%20%3D%20vec!%5B1%2C%202%2C%203%5D%3B%0Alet%20int_slice%20%3D%20%26vec%5B..%5D%3B%0A%2F%2F%20coercing%20an%20array%20to%20a%20slice%0Alet%20str_slice%3A%20%26%5B%26str%5D%20%3D%20%26%5B%22one%22%2C%20%22two%22%2C%20%22three%22%5D%3B%0A%7D">Run</a></pre>
<p>Slices are either mutable or shared. The shared slice type is <code>&[T]</code>,
while the mutable slice type is <code>&mut [T]</code>, where <code>T</code> represents the element
type. For example, you can mutate the block of memory that a mutable slice
points to:</p>
<pre class="rust rust-example-rendered">
<span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
<span class="ident">x</span>[<span class="number">1</span>] <span class="op">=</span> <span class="number">7</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">7</span>, <span class="number">3</span>]);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Alet%20x%20%3D%20%26mut%20%5B1%2C%202%2C%203%5D%3B%0Ax%5B1%5D%20%3D%207%3B%0Aassert_eq!(x%2C%20%26%5B1%2C%207%2C%203%5D)%3B%0A%7D">Run</a></pre>
<p>Here are some of the things this module contains:</p>
<h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<p>There are several structs that are useful for slices, such as <a href="struct.Iter.html"><code>Iter</code></a>, which
represents iteration over a slice.</p>
<h2 id="trait-implementations" class="section-header"><a href="#trait-implementations">Trait Implementations</a></h2>
<p>There are several implementations of common traits for slices. Some examples
include:</p>
<ul>
<li><a href="../../std/clone/trait.Clone.html"><code>Clone</code></a></li>
<li><a href="../../std/cmp/trait.Eq.html"><code>Eq</code></a>, <a href="../../std/cmp/trait.Ord.html"><code>Ord</code></a> - for slices whose element type are <a href="../../std/cmp/trait.Eq.html"><code>Eq</code></a> or <a href="../../std/cmp/trait.Ord.html"><code>Ord</code></a>.</li>
<li><a href="../../std/hash/trait.Hash.html"><code>Hash</code></a> - for slices whose element type is <a href="../../std/hash/trait.Hash.html"><code>Hash</code></a>.</li>
</ul>
<h2 id="iteration" class="section-header"><a href="#iteration">Iteration</a></h2>
<p>The slices implement <code>IntoIterator</code>. The iterator yields references to the
slice elements.</p>
<pre class="rust rust-example-rendered">
<span class="kw">let</span> <span class="ident">numbers</span> <span class="op">=</span> <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
<span class="kw">for</span> <span class="ident">n</span> <span class="kw">in</span> <span class="ident">numbers</span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{} is a number!"</span>, <span class="ident">n</span>);
}<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Alet%20numbers%20%3D%20%26%5B0%2C%201%2C%202%5D%3B%0Afor%20n%20in%20numbers%20%7B%0A%20%20%20%20println!(%22%7B%7D%20is%20a%20number!%22%2C%20n)%3B%0A%7D%0A%7D">Run</a></pre>
<p>The mutable slice yields mutable references to the elements:</p>
<pre class="rust rust-example-rendered">
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">scores</span> <span class="op">=</span> [<span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>];
<span class="kw">for</span> <span class="ident">score</span> <span class="kw">in</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">scores</span>[..] {
<span class="kw-2">*</span><span class="ident">score</span> <span class="op">+=</span> <span class="number">1</span>;
}<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Alet%20mut%20scores%20%3D%20%5B7%2C%208%2C%209%5D%3B%0Afor%20score%20in%20%26mut%20scores%5B..%5D%20%7B%0A%20%20%20%20*score%20%2B%3D%201%3B%0A%7D%0A%7D">Run</a></pre>
<p>This iterator yields mutable references to the slice's elements, so while
the element type of the slice is <code>i32</code>, the element type of the iterator is
<code>&mut i32</code>.</p>
<ul>
<li><a href="../../std/primitive.slice.html#method.iter"><code>.iter</code></a> and <a href="../../std/primitive.slice.html#method.iter_mut"><code>.iter_mut</code></a> are the explicit methods to return the default
iterators.</li>
<li>Further methods that return iterators are <a href="../../std/primitive.slice.html#method.split"><code>.split</code></a>, <a href="../../std/primitive.slice.html#method.splitn"><code>.splitn</code></a>,
<a href="../../std/primitive.slice.html#method.chunks"><code>.chunks</code></a>, <a href="../../std/primitive.slice.html#method.windows"><code>.windows</code></a> and more.</li>
</ul>
<p><em><a href="../../std/primitive.slice.html">See also the slice primitive type</a>.</em></p>
</div><h2 id='structs-1' class='section-header'><a href="#structs-1">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Chunks.html"
title='struct std::slice::Chunks'>Chunks</a></td>
<td class='docblock-short'>
<p>An iterator over a slice in (non-overlapping) chunks (<code>chunk_size</code> elements at a
time).</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ChunksMut.html"
title='struct std::slice::ChunksMut'>ChunksMut</a></td>
<td class='docblock-short'>
<p>An iterator over a slice in (non-overlapping) mutable chunks (<code>chunk_size</code>
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.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Iter.html"
title='struct std::slice::Iter'>Iter</a></td>
<td class='docblock-short'>
<p>Immutable slice iterator</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.IterMut.html"
title='struct std::slice::IterMut'>IterMut</a></td>
<td class='docblock-short'>
<p>Mutable slice iterator.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.RSplitN.html"
title='struct std::slice::RSplitN'>RSplitN</a></td>
<td class='docblock-short'>
<p>An iterator over subslices separated by elements that match a
predicate function, limited to a given number of splits, starting
from the end of the slice.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.RSplitNMut.html"
title='struct std::slice::RSplitNMut'>RSplitNMut</a></td>
<td class='docblock-short'>
<p>An iterator over subslices separated by elements that match a
predicate function, limited to a given number of splits, starting
from the end of the slice.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Split.html"
title='struct std::slice::Split'>Split</a></td>
<td class='docblock-short'>
<p>An iterator over subslices separated by elements that match a predicate
function.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SplitMut.html"
title='struct std::slice::SplitMut'>SplitMut</a></td>
<td class='docblock-short'>
<p>An iterator over the subslices of the vector which are separated
by elements that match <code>pred</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SplitN.html"
title='struct std::slice::SplitN'>SplitN</a></td>
<td class='docblock-short'>
<p>An iterator over subslices separated by elements that match a predicate
function, limited to a given number of splits.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SplitNMut.html"
title='struct std::slice::SplitNMut'>SplitNMut</a></td>
<td class='docblock-short'>
<p>An iterator over subslices separated by elements that match a predicate
function, limited to a given number of splits.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Windows.html"
title='struct std::slice::Windows'>Windows</a></td>
<td class='docblock-short'>
<p>An iterator over overlapping subslices of length <code>size</code>.</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.ExactChunks.html"
title='struct std::slice::ExactChunks'>ExactChunks</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>An iterator over a slice in (non-overlapping) chunks (<code>chunk_size</code> elements at a
time).</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.ExactChunksMut.html"
title='struct std::slice::ExactChunksMut'>ExactChunksMut</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>An iterator over a slice in (non-overlapping) mutable chunks (<code>chunk_size</code>
elements at a time). When the slice len is not evenly divided by the chunk
size, the last up to <code>chunk_size-1</code> elements will be omitted.</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.RSplit.html"
title='struct std::slice::RSplit'>RSplit</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>An iterator over subslices separated by elements that match a predicate
function, starting from the end of the slice.</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.RSplitMut.html"
title='struct std::slice::RSplitMut'>RSplitMut</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>An iterator over the subslices of the vector which are separated
by elements that match <code>pred</code>, starting from the end of the slice.</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class='unstable module-item'>
<td><a class="trait" href="trait.SliceConcatExt.html"
title='trait std::slice::SliceConcatExt'>SliceConcatExt</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>An extension trait for concatenating slices</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="trait" href="trait.SliceIndex.html"
title='trait std::slice::SliceIndex'>SliceIndex</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>A helper trait used for indexing operations.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.from_raw_parts.html"
title='fn std::slice::from_raw_parts'>from_raw_parts</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
<td class='docblock-short'>
<p>Forms a slice from a pointer and a length.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.from_raw_parts_mut.html"
title='fn std::slice::from_raw_parts_mut'>from_raw_parts_mut</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td>
<td class='docblock-short'>
<p>Performs the same functionality as <code>from_raw_parts</code>, except that a mutable
slice is returned.</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.from_ref.html"
title='fn std::slice::from_ref'>from_ref</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>Converts a reference to T into a slice of length 1 (without copying).</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.from_ref_mut.html"
title='fn std::slice::from_ref_mut'>from_ref_mut</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>Converts a reference to T into a slice of length 1 (without copying).</p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "std";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
fdedb3cf2140df9b6d419a2338ab1caa
>
files
>
5650
