mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 08:28:24 +00:00
2687 lines
486 KiB
HTML
2687 lines
486 KiB
HTML
|
<!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="A `Vec`-like container that can store a small number of elements inline."><title>SmallVec in smallvec - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="smallvec" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../smallvec/index.html">smallvec</a><span class="version">1.13.1</span></h2></div><h2 class="location"><a href="#">SmallVec</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.append">append</a></li><li><a href="#method.as_mut_ptr">as_mut_ptr</a></li><li><a href="#method.as_mut_slice">as_mut_slice</a></li><li><a href="#method.as_ptr">as_ptr</a></li><li><a href="#method.as_slice">as_slice</a></li><li><a href="#method.capacity">capacity</a></li><li><a href="#method.clear">clear</a></li><li><a href="#method.dedup">dedup</a></li><li><a href="#method.dedup_by">dedup_by</a></li><li><a href="#method.dedup_by_key">dedup_by_key</a></li><li><a href="#method.drain">drain</a></li><li><a href="#method.extend_from_slice">extend_from_slice</a></li><li><a href="#method.from_buf">from_buf</a></li><li><a href="#method.from_buf_and_len">from_buf_and_len</a></li><li><a href="#method.from_buf_and_len_unchecked">from_buf_and_len_unchecked</a></li><li><a href="#method.from_elem">from_elem</a></li><li><a href="#method.from_raw_parts">from_raw_parts</a></li><li><a href="#method.from_slice">from_slice</a></li><li><a href="#method.from_vec">from_vec</a></li><li><a href="#method.grow">grow</a></li><li><a href="#method.inline_size">inline_size</a></li><li><a href="#method.insert">insert</a></li><li><a href="#method.insert_from_slice">insert_from_slice</a></li><li><a href="#method.insert_many">insert_many</a></li><li><a href="#method.into_boxed_slice">into_boxed_slice</a></li><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.into_vec">into_vec</a></li><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.len">len</a></li><li><a href="#method.new">n
|
|||
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../smallvec/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="index.html">smallvec</a>::<wbr><a class="struct" href="#">SmallVec</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/smallvec/lib.rs.html#768-774">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct SmallVec<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A <code>Vec</code>-like container that can store a small number of elements inline.</p>
|
|||
|
|
<p><code>SmallVec</code> acts like a vector, but can store a limited amount of data inline within the
|
|||
|
|
<code>SmallVec</code> struct rather than in a separate allocation. If the data exceeds this limit, the
|
|||
|
|
<code>SmallVec</code> will “spill” its data onto the heap, allocating a new buffer to hold it.</p>
|
|||
|
|
<p>The amount of data that a <code>SmallVec</code> can store inline depends on its backing store. The backing
|
|||
|
|
store can be any type that implements the <code>Array</code> trait; usually it is a small fixed-sized
|
|||
|
|
array. For example a <code>SmallVec<[u64; 8]></code> can hold up to eight 64-bit integers inline.</p>
|
|||
|
|
<h3 id="example"><a href="#example">Example</a></h3>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>smallvec::SmallVec;
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>v = SmallVec::<[u8; <span class="number">4</span>]>::new(); <span class="comment">// initialize an empty vector
|
|||
|
|
|
|||
|
|
// The vector can hold up to 4 items without spilling onto the heap.
|
|||
|
|
</span>v.extend(<span class="number">0</span>..<span class="number">4</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(v.len(), <span class="number">4</span>);
|
|||
|
|
<span class="macro">assert!</span>(!v.spilled());
|
|||
|
|
|
|||
|
|
<span class="comment">// Pushing another element will force the buffer to spill:
|
|||
|
|
</span>v.push(<span class="number">4</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(v.len(), <span class="number">5</span>);
|
|||
|
|
<span class="macro">assert!</span>(v.spilled());</code></pre></div>
|
|||
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#776-1729">source</a><a href="#impl-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#779-790">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h4></section></summary><div class="docblock"><p>Construct an empty vector</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_capacity" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#806-810">source</a><h4 class="code-header">pub fn <a href="#method.with_capacity" class="fn">with_capacity</a>(n: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> Self</h4></section></summary><div class="docblock"><p>Construct an empty vector with enough capacity pre-allocated to store at least <code>n</code>
|
|||
|
|
elements.</p>
|
|||
|
|
<p>Will create a heap allocation only if <code>n</code> is larger than the inline capacity.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
|
|||
|
|
<span class="kw">let </span>v: SmallVec<[u8; <span class="number">3</span>]> = SmallVec::with_capacity(<span class="number">100</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert!</span>(v.is_empty());
|
|||
|
|
<span class="macro">assert!</span>(v.capacity() >= <span class="number">100</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_vec" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#825-852">source</a><h4 class="code-header">pub fn <a href="#method.from_vec" class="fn">from_vec</a>(vec: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>>) -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h4></section></summary><div class="docblock"><p>Construct a new <code>SmallVec</code> from a <code>Vec<A::Item></code>.</p>
|
|||
|
|
<p>Elements will be copied to the inline buffer if <code>vec.capacity() <= Self::inline_capacity()</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>smallvec::SmallVec;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>vec = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
|
|||
|
|
<span class="kw">let </span>small_vec: SmallVec<[<span class="kw">_</span>; <span class="number">3</span>]> = SmallVec::from_vec(vec);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>small_vec, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_buf" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#866-871">source</a><h4 class="code-header">pub fn <a href="#method.from_buf" class="fn">from_buf</a>(buf: A) -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h4></section></summary><div class="docblock"><p>Constructs a new <code>SmallVec</code> on the stack from an <code>A</code> without
|
|||
|
|
copying elements.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>smallvec::SmallVec;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>buf = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
|
|||
|
|
<span class="kw">let </span>small_vec: SmallVec<<span class="kw">_</span>> = SmallVec::from_buf(buf);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>small_vec, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_buf_and_len" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#886-889">source</a><h4 class="code-header">pub fn <a href="#method.from_buf_and_len" class="fn">from_buf_and_len</a>(buf: A, len: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h4></section></summary><div class="docblock"><p>Constructs a new <code>SmallVec</code> on the stack from an <code>A</code> without
|
|||
|
|
copying elements. Also sets the length, which must be less or
|
|||
|
|
equal to the size of <code>buf</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>smallvec::SmallVec;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>buf = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
<span class="kw">let </span>small_vec: SmallVec<<span class="kw">_</span>> = SmallVec::from_buf_and_len(buf, <span class="number">5</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>small_vec, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_buf_and_len_unchecked" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#907-912">source</a><h4 class="code-header">pub unsafe fn <a href="#method.from_buf_and_len_unchecked" class="fn">from_buf_and_len_unchecked</a>(
|
|||
|
|
buf: <a class="union" href="https://doc.rust-lang.org/1.76.0/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a><A>,
|
|||
|
|
len: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>
|
|||
|
|
) -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h4></section></summary><div class="docblock"><p>Constructs a new <code>SmallVec</code> on the stack from an <code>A</code> without
|
|||
|
|
copying elements. Also sets the length. The user is responsible
|
|||
|
|
for ensuring that <code>len <= A::size()</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>smallvec::SmallVec;
|
|||
|
|
<span class="kw">use </span>std::mem::MaybeUninit;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>buf = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
<span class="kw">let </span>small_vec: SmallVec<<span class="kw">_</span>> = <span class="kw">unsafe </span>{
|
|||
|
|
SmallVec::from_buf_and_len_unchecked(MaybeUninit::new(buf), <span class="number">5</span>)
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>small_vec, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_len" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#919-922">source</a><h4 class="code-header">pub unsafe fn <a href="#method.set_len" class="fn">set_len</a>(&mut self, new_len: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Sets the length of a vector.</p>
|
|||
|
|
<p>This will explicitly set the size of the vector, without actually
|
|||
|
|
modifying its buffers, so it is up to the caller to ensure that the
|
|||
|
|
vector is actually the specified size.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.inline_size" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#946-948">source</a><h4 class="code-header">pub fn <a href="#method.inline_size" class="fn">inline_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>The maximum number of elements this vector can hold inline</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#952-954">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>The number of elements stored in the vector</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#958-960">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the vector is empty</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.capacity" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#964-966">source</a><h4 class="code-header">pub fn <a href="#method.capacity" class="fn">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>The number of items the vector can hold without reallocating</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.spilled" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1001-1003">source</a><h4 class="code-header">pub fn <a href="#method.spilled" class="fn">spilled</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the data has spilled into a separate heap-allocated buffer.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.drain" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1018-1052">source</a><h4 class="code-header">pub fn <a href="#method.drain" class="fn">drain</a><R>(&mut self, range: R) -> <a class="struct" href="struct.Drain.html" title="struct smallvec::Drain">Drain</a><'_, A> <a href="#" class="tooltip" data-notable-ty="Drain<'_, A>">ⓘ</a><div class="where">where
|
|||
|
|
R: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/range/trait.RangeBounds.html" title="trait core::ops::range::RangeBounds">RangeBounds</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>,</div></h4></section></summary><div class="docblock"><p>Creates a draining iterator that removes the specified range in the vector
|
|||
|
|
and yields the removed items.</p>
|
|||
|
|
<p>Note 1: The element range is removed even if the iterator is only
|
|||
|
|
partially consumed or not consumed at all.</p>
|
|||
|
|
<p>Note 2: It is unspecified how many elements are removed from the vector
|
|||
|
|
if the <code>Drain</code> value is leaked.</p>
|
|||
|
|
<h5 id="panics"><a href="#panics">Panics</a></h5>
|
|||
|
|
<p>Panics if the starting point is greater than the end point or if
|
|||
|
|
the end point is greater than the length of the vector.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.push" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1114-1126">source</a><h4 class="code-header">pub fn <a href="#method.push" class="fn">push</a>(&mut self, value: A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>)</h4></section></summary><div class="docblock"><p>Append an item to the vector.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.pop" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1130-1141">source</a><h4 class="code-header">pub fn <a href="#method.pop" class="fn">pop</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>></h4></section></summary><div class="docblock"><p>Remove an item from the end of the vector and return it, or None if empty.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.append" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1155-1160">source</a><h4 class="code-header">pub fn <a href="#method.append" class="fn">append</a><B>(&mut self, other: &mut <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><B>)<div class="where">where
|
|||
|
|
B: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a><Item = A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>>,</div></h4></section></summary><div class="docblock"><p>Moves all the elements of <code>other</code> into <code>self</code>, leaving <code>other</code> empty.</p>
|
|||
|
|
<h5 id="example-1"><a href="#example-1">Example</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v0: SmallVec<[u8; <span class="number">16</span>]> = <span class="macro">smallvec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>v1: SmallVec<[u8; <span class="number">32</span>]> = <span class="macro">smallvec!</span>[<span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>];
|
|||
|
|
v0.append(<span class="kw-2">&mut </span>v1);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>v0, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>v1, []);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.grow" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1166-1168">source</a><h4 class="code-header">pub fn <a href="#method.grow" class="fn">grow</a>(&mut self, new_cap: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Re-allocate to set the capacity to <code>max(new_cap, inline_size())</code>.</p>
|
|||
|
|
<p>Panics if <code>new_cap</code> is less than the vector’s length
|
|||
|
|
or if the capacity computation overflows <code>usize</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_grow" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1173-1211">source</a><h4 class="code-header">pub fn <a href="#method.try_grow" class="fn">try_grow</a>(&mut self, new_cap: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.unit.html">()</a>, <a class="enum" href="enum.CollectionAllocErr.html" title="enum smallvec::CollectionAllocErr">CollectionAllocErr</a>></h4></section></summary><div class="docblock"><p>Re-allocate to set the capacity to <code>max(new_cap, inline_size())</code>.</p>
|
|||
|
|
<p>Panics if <code>new_cap</code> is less than the vector’s length</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.reserve" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1219-1221">source</a><h4 class="code-header">pub fn <a href="#method.reserve" class="fn">reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Reserve capacity for <code>additional</code> more elements to be inserted.</p>
|
|||
|
|
<p>May reserve more space to avoid frequent reallocations.</p>
|
|||
|
|
<p>Panics if the capacity computation overflows <code>usize</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_reserve" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1237-1249">source</a><h4 class="code-header">pub fn <a href="#method.try_reserve" class="fn">try_reserve</a>(
|
|||
|
|
&mut self,
|
|||
|
|
additional: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.unit.html">()</a>, <a class="enum" href="enum.CollectionAllocErr.html" title="enum smallvec::CollectionAllocErr">CollectionAllocErr</a>></h4></section></summary><div class="docblock"><p>Reserve capacity for <code>additional</code> more elements to be inserted.</p>
|
|||
|
|
<p>May reserve more space to avoid frequent reallocations.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.reserve_exact" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1254-1256">source</a><h4 class="code-header">pub fn <a href="#method.reserve_exact" class="fn">reserve_exact</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Reserve the minimum capacity for <code>additional</code> more elements to be inserted.</p>
|
|||
|
|
<p>Panics if the new capacity overflows <code>usize</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_reserve_exact" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1259-1268">source</a><h4 class="code-header">pub fn <a href="#method.try_reserve_exact" class="fn">try_reserve_exact</a>(
|
|||
|
|
&mut self,
|
|||
|
|
additional: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.unit.html">()</a>, <a class="enum" href="enum.CollectionAllocErr.html" title="enum smallvec::CollectionAllocErr">CollectionAllocErr</a>></h4></section></summary><div class="docblock"><p>Reserve the minimum capacity for <code>additional</code> more elements to be inserted.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.shrink_to_fit" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1274-1290">source</a><h4 class="code-header">pub fn <a href="#method.shrink_to_fit" class="fn">shrink_to_fit</a>(&mut self)</h4></section></summary><div class="docblock"><p>Shrink the capacity of the vector as much as possible.</p>
|
|||
|
|
<p>When possible, this will move data from an external heap buffer to the vector’s inline
|
|||
|
|
storage.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.truncate" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1299-1309">source</a><h4 class="code-header">pub fn <a href="#method.truncate" class="fn">truncate</a>(&mut self, len: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Shorten the vector, keeping the first <code>len</code> elements and dropping the rest.</p>
|
|||
|
|
<p>If <code>len</code> is greater than or equal to the vector’s current length, this has no
|
|||
|
|
effect.</p>
|
|||
|
|
<p>This does not re-allocate. If you want the vector’s capacity to shrink, call
|
|||
|
|
<code>shrink_to_fit</code> after truncating.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_slice" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1314-1316">source</a><h4 class="code-header">pub fn <a href="#method.as_slice" class="fn">as_slice</a>(&self) -> &[A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]</h4></section></summary><div class="docblock"><p>Extracts a slice containing the entire vector.</p>
|
|||
|
|
<p>Equivalent to <code>&s[..]</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_mut_slice" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1321-1323">source</a><h4 class="code-header">pub fn <a href="#method.as_mut_slice" class="fn">as_mut_slice</a>(&mut self) -> &mut [A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]</h4></section></summary><div class="docblock"><p>Extracts a mutable slice of the entire vector.</p>
|
|||
|
|
<p>Equivalent to <code>&mut s[..]</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.swap_remove" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1331-1336">source</a><h4 class="code-header">pub fn <a href="#method.swap_remove" class="fn">swap_remove</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a></h4></section></summary><div class="docblock"><p>Remove the element at position <code>index</code>, replacing it with the last element.</p>
|
|||
|
|
<p>This does not preserve ordering, but is O(1).</p>
|
|||
|
|
<p>Panics if <code>index</code> is out of bounds.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.clear" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1340-1342">source</a><h4 class="code-header">pub fn <a href="#method.clear" class="fn">clear</a>(&mut self)</h4></section></summary><div class="docblock"><p>Remove all elements from the vector.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1348-1359">source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a></h4></section></summary><div class="docblock"><p>Remove and return the element at position <code>index</code>, shifting all elements after it to the
|
|||
|
|
left.</p>
|
|||
|
|
<p>Panics if <code>index</code> is out of bounds.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1364-1386">source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, element: A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>)</h4></section></summary><div class="docblock"><p>Insert an element at position <code>index</code>, shifting all elements after it to the right.</p>
|
|||
|
|
<p>Panics if <code>index > len</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert_many" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1390-1472">source</a><h4 class="code-header">pub fn <a href="#method.insert_many" class="fn">insert_many</a><I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>>>(
|
|||
|
|
&mut self,
|
|||
|
|
index: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>,
|
|||
|
|
iterable: I
|
|||
|
|
)</h4></section></summary><div class="docblock"><p>Insert multiple elements at position <code>index</code>, shifting all following elements toward the
|
|||
|
|
back.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_vec" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1476-1487">source</a><h4 class="code-header">pub fn <a href="#method.into_vec" class="fn">into_vec</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>></h4></section></summary><div class="docblock"><p>Convert a <code>SmallVec</code> to a <code>Vec</code>, without reallocating if the <code>SmallVec</code> has already spilled onto
|
|||
|
|
the heap.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_boxed_slice" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1493-1495">source</a><h4 class="code-header">pub fn <a href="#method.into_boxed_slice" class="fn">into_boxed_slice</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><[A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]></h4></section></summary><div class="docblock"><p>Converts a <code>SmallVec</code> into a <code>Box<[T]></code> without reallocating if the <code>SmallVec</code> has already spilled
|
|||
|
|
onto the heap.</p>
|
|||
|
|
<p>Note that this will drop any excess capacity.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_inner" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1501-1512">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fn">into_inner</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><A, Self></h4></section></summary><div class="docblock"><p>Convert the <code>SmallVec</code> into an <code>A</code> if possible. Otherwise return <code>Err(Self)</code>.</p>
|
|||
|
|
<p>This method returns <code>Err(Self)</code> if the <code>SmallVec</code> is too short (and the <code>A</code> contains uninitialized elements),
|
|||
|
|
or if the <code>SmallVec</code> is too long (and all the elements were spilled to the heap).</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.retain" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1519-1530">source</a><h4 class="code-header">pub fn <a href="#method.retain" class="fn">retain</a><F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>>(&mut self, f: F)</h4></section></summary><div class="docblock"><p>Retains only the elements specified by the predicate.</p>
|
|||
|
|
<p>In other words, remove all elements <code>e</code> such that <code>f(&e)</code> returns <code>false</code>.
|
|||
|
|
This method operates in place and preserves the order of the retained
|
|||
|
|
elements.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.retain_mut" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1537-1539">source</a><h4 class="code-header">pub fn <a href="#method.retain_mut" class="fn">retain_mut</a><F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>>(&mut self, f: F)</h4></section></summary><div class="docblock"><p>Retains only the elements specified by the predicate.</p>
|
|||
|
|
<p>This method is identical in behaviour to [<code>retain</code>]; it is included only
|
|||
|
|
to maintain api-compatability with <code>std::Vec</code>, where the methods are
|
|||
|
|
separate for historical reasons.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.dedup" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1542-1547">source</a><h4 class="code-header">pub fn <a href="#method.dedup" class="fn">dedup</a>(&mut self)<div class="where">where
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>>,</div></h4></section></summary><div class="docblock"><p>Removes consecutive duplicate elements.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.dedup_by" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1550-1579">source</a><h4 class="code-header">pub fn <a href="#method.dedup_by" class="fn">dedup_by</a><F>(&mut self, same_bucket: F)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>, &mut A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Removes consecutive duplicate elements using the given equality relation.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.dedup_by_key" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1582-1588">source</a><h4 class="code-header">pub fn <a href="#method.dedup_by_key" class="fn">dedup_by_key</a><F, K>(&mut self, key: F)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&mut A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>) -> K,
|
|||
|
|
K: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><K>,</div></h4></section></summary><div class="docblock"><p>Removes consecutive elements that map to the same key.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.resize_with" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1615-1630">source</a><h4 class="code-header">pub fn <a href="#method.resize_with" class="fn">resize_with</a><F>(&mut self, new_len: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, f: F)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>() -> A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>,</div></h4></section></summary><div class="docblock"><p>Resizes the <code>SmallVec</code> in-place so that <code>len</code> is equal to <code>new_len</code>.</p>
|
|||
|
|
<p>If <code>new_len</code> is greater than <code>len</code>, the <code>SmallVec</code> is extended by the difference, with each
|
|||
|
|
additional slot filled with the result of calling the closure <code>f</code>. The return values from <code>f</code>
|
|||
|
|
will end up in the <code>SmallVec</code> in the order they have been generated.</p>
|
|||
|
|
<p>If <code>new_len</code> is less than <code>len</code>, the <code>SmallVec</code> is simply truncated.</p>
|
|||
|
|
<p>This method uses a closure to create new values on every push. If you’d rather <code>Clone</code> a given
|
|||
|
|
value, use <code>resize</code>. If you want to use the <code>Default</code> trait to generate values, you can pass
|
|||
|
|
<code>Default::default()</code> as the second argument.</p>
|
|||
|
|
<p>Added for <code>std::vec::Vec</code> compatibility (added in Rust 1.33.0)</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>vec : SmallVec<[<span class="kw">_</span>; <span class="number">4</span>]> = <span class="macro">smallvec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|||
|
|
vec.resize_with(<span class="number">5</span>, Default::default);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>vec, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">0</span>, <span class="number">0</span>]);
|
|||
|
|
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>vec : SmallVec<[<span class="kw">_</span>; <span class="number">4</span>]> = <span class="macro">smallvec!</span>[];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>p = <span class="number">1</span>;
|
|||
|
|
vec.resize_with(<span class="number">4</span>, || { p <span class="kw-2">*</span>= <span class="number">2</span>; p });
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>vec, <span class="kw-2">&</span>[<span class="number">2</span>, <span class="number">4</span>, <span class="number">8</span>, <span class="number">16</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_raw_parts" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1700-1712">source</a><h4 class="code-header">pub unsafe fn <a href="#method.from_raw_parts" class="fn">from_raw_parts</a>(
|
|||
|
|
ptr: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.pointer.html">*mut </a>A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>,
|
|||
|
|
length: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>,
|
|||
|
|
capacity: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>
|
|||
|
|
) -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h4></section></summary><div class="docblock"><p>Creates a <code>SmallVec</code> directly from the raw components of another
|
|||
|
|
<code>SmallVec</code>.</p>
|
|||
|
|
<h5 id="safety"><a href="#safety">Safety</a></h5>
|
|||
|
|
<p>This is highly unsafe, due to the number of invariants that aren’t
|
|||
|
|
checked:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>ptr</code> needs to have been previously allocated via <code>SmallVec</code> for its
|
|||
|
|
spilled storage (at least, it’s highly likely to be incorrect if it
|
|||
|
|
wasn’t).</li>
|
|||
|
|
<li><code>ptr</code>’s <code>A::Item</code> type needs to be the same size and alignment that
|
|||
|
|
it was allocated with</li>
|
|||
|
|
<li><code>length</code> needs to be less than or equal to <code>capacity</code>.</li>
|
|||
|
|
<li><code>capacity</code> needs to be the capacity that the pointer was allocated
|
|||
|
|
with.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Violating these may cause problems like corrupting the allocator’s
|
|||
|
|
internal data structures.</p>
|
|||
|
|
<p>Additionally, <code>capacity</code> must be greater than the amount of inline
|
|||
|
|
storage <code>A</code> has; that is, the new <code>SmallVec</code> must need to spill over
|
|||
|
|
into heap allocated storage. This condition is asserted against.</p>
|
|||
|
|
<p>The ownership of <code>ptr</code> is effectively transferred to the
|
|||
|
|
<code>SmallVec</code> which may then deallocate, reallocate or change the
|
|||
|
|
contents of memory pointed to by the pointer at will. Ensure
|
|||
|
|
that nothing else uses the pointer after calling this
|
|||
|
|
function.</p>
|
|||
|
|
<h5 id="examples"><a href="#examples">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::mem;
|
|||
|
|
<span class="kw">use </span>std::ptr;
|
|||
|
|
|
|||
|
|
<span class="kw">fn </span>main() {
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>v: SmallVec<[<span class="kw">_</span>; <span class="number">1</span>]> = <span class="macro">smallvec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|||
|
|
|
|||
|
|
<span class="comment">// Pull out the important parts of `v`.
|
|||
|
|
</span><span class="kw">let </span>p = v.as_mut_ptr();
|
|||
|
|
<span class="kw">let </span>len = v.len();
|
|||
|
|
<span class="kw">let </span>cap = v.capacity();
|
|||
|
|
<span class="kw">let </span>spilled = v.spilled();
|
|||
|
|
|
|||
|
|
<span class="kw">unsafe </span>{
|
|||
|
|
<span class="comment">// Forget all about `v`. The heap allocation that stored the
|
|||
|
|
// three values won't be deallocated.
|
|||
|
|
</span>mem::forget(v);
|
|||
|
|
|
|||
|
|
<span class="comment">// Overwrite memory with [4, 5, 6].
|
|||
|
|
//
|
|||
|
|
// This is only safe if `spilled` is true! Otherwise, we are
|
|||
|
|
// writing into the old `SmallVec`'s inline storage on the
|
|||
|
|
// stack.
|
|||
|
|
</span><span class="macro">assert!</span>(spilled);
|
|||
|
|
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..len {
|
|||
|
|
ptr::write(p.add(i), <span class="number">4 </span>+ i);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="comment">// Put everything back together into a SmallVec with a different
|
|||
|
|
// amount of inline storage, but which is still less than `cap`.
|
|||
|
|
</span><span class="kw">let </span>rebuilt = SmallVec::<[<span class="kw">_</span>; <span class="number">2</span>]>::from_raw_parts(p, len, cap);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>rebuilt, <span class="kw-2">&</span>[<span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
}
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_ptr" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1715-1720">source</a><h4 class="code-header">pub fn <a href="#method.as_ptr" class="fn">as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.pointer.html">*const </a>A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a></h4></section></summary><div class="docblock"><p>Returns a raw pointer to the vector’s buffer.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_mut_ptr" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1723-1728">source</a><h4 class="code-header">pub fn <a href="#method.as_mut_ptr" class="fn">as_mut_ptr</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.pointer.html">*mut </a>A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a></h4></section></summary><div class="docblock"><p>Returns a raw mutable pointer to the vector’s buffer.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-SmallVec%3CA%3E-1" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#1731-1793">source</a><a href="#impl-SmallVec%3CA%3E-1" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_slice" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1738-1763">source</a><h4 class="code-header">pub fn <a href="#method.from_slice" class="fn">from_slice</a>(slice: &[A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]) -> Self</h4></section></summary><div class="docblock"><p>Copy the elements from a slice into a new <code>SmallVec</code>.</p>
|
|||
|
|
<p>For slices of <code>Copy</code> types, this is more efficient than <code>SmallVec::from(slice)</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert_from_slice" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1770-1783">source</a><h4 class="code-header">pub fn <a href="#method.insert_from_slice" class="fn">insert_from_slice</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, slice: &[A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>])</h4></section></summary><div class="docblock"><p>Copy elements from a slice into the vector at position <code>index</code>, shifting any following
|
|||
|
|
elements toward the back.</p>
|
|||
|
|
<p>For slices of <code>Copy</code> types, this is more efficient than <code>insert</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.extend_from_slice" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1789-1792">source</a><h4 class="code-header">pub fn <a href="#method.extend_from_slice" class="fn">extend_from_slice</a>(&mut self, slice: &[A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>])</h4></section></summary><div class="docblock"><p>Copy elements from a slice and append them to the vector.</p>
|
|||
|
|
<p>For slices of <code>Copy</code> types, this is more efficient than <code>extend</code>.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-SmallVec%3CA%3E-2" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#1795-1840">source</a><a href="#impl-SmallVec%3CA%3E-2" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.resize" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1805-1813">source</a><h4 class="code-header">pub fn <a href="#method.resize" class="fn">resize</a>(&mut self, len: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, value: A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>)</h4></section></summary><div class="docblock"><p>Resizes the vector so that its length is equal to <code>len</code>.</p>
|
|||
|
|
<p>If <code>len</code> is less than the current length, the vector simply truncated.</p>
|
|||
|
|
<p>If <code>len</code> is greater than the current length, <code>value</code> is appended to the
|
|||
|
|
vector until its length equals <code>len</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.from_elem" class="method"><a class="src rightside" href="../src/smallvec/lib.rs.html#1822-1839">source</a><h4 class="code-header">pub fn <a href="#method.from_elem" class="fn">from_elem</a>(elem: A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>, n: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> Self</h4></section></summary><div class="docblock"><p>Creates a <code>SmallVec</code> with <code>n</code> copies of <code>elem</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>smallvec::SmallVec;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>v = SmallVec::<[char; <span class="number">128</span>]>::from_elem(<span class="string">'d'</span>, <span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(v, SmallVec::from_buf([<span class="string">'d'</span>, <span class="string">'d'</span>]));</code></pre></div>
|
|||
|
|
</div></details></div></details></div><h2 id="deref-methods-%5BA::Item%5D" class="section-header"><span>Methods from <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = [A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]></span><a href="#deref-methods-%5BA::Item%5D" class="anchor">§</a></h2><div id="deref-methods-%5BA::Item%5D-1" class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_str" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/ascii/ascii_char.rs.html#544">source</a><h4 class="code-header">pub fn <a href="#method.as_str" class="fn">as_str</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.str.html">str</a></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>ascii_char</code>)</span></div></span></summary><div class="docblock"><p>Views this slice of ASCII characters as a UTF-8 <code>str</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_bytes" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/ascii/ascii_char.rs.html#555">source</a><h4 class="code-header">pub fn <a href="#method.as_bytes" class="fn">as_bytes</a>(&self) -> &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>ascii_char</code>)</span></div></span></summary><div class="docblock"><p>Views this slice of ASCII characters as a slice of <code>u8</code> bytes.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_ascii" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/ascii.rs.html#16">source</a></span><h4 class="code-header">pub fn <a href="#method.is_ascii" class="fn">is_ascii</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if all bytes in this slice are within the ASCII range.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_ascii" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/ascii.rs.html#25">source</a><h4 class="code-header">pub fn <a href="#method.as_ascii" class="fn">as_ascii</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/ascii/ascii_char/enum.AsciiChar.html" title="enum core::ascii::ascii_char::AsciiChar">AsciiChar</a>]></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>ascii_char</code>)</span></div></span></summary><div class="docblock"><p>If this slice <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.is_ascii" title="method slice::is_ascii"><code>is_ascii</code></a>, returns it as a slice of
|
|||
|
|
<a href="https://doc.rust-lang.org/1.76.0/core/ascii/ascii_char/enum.AsciiChar.html" title="enum core::ascii::ascii_char::AsciiChar">ASCII characters</a>, otherwise returns <code>None</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_ascii_unchecked" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/ascii.rs.html#43">source</a><h4 class="code-header">pub unsafe fn <a href="#method.as_ascii_unchecked" class="fn">as_ascii_unchecked</a>(&self) -> &[<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/ascii/ascii_char/enum.AsciiChar.html" title="enum core::ascii::ascii_char::AsciiChar">AsciiChar</a>]</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>ascii_char</code>)</span></div></span></summary><div class="docblock"><p>Converts this slice of bytes into a slice of ASCII characters,
|
|||
|
|
without checking whether they’re valid.</p>
|
|||
|
|
<h5 id="safety-1"><a href="#safety-1">Safety</a></h5>
|
|||
|
|
<p>Every byte in the slice must be in <code>0..=127</code>, or else this is UB.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.eq_ignore_ascii_case" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/ascii.rs.html#57">source</a></span><h4 class="code-header">pub fn <a href="#method.eq_ignore_ascii_case" class="fn">eq_ignore_ascii_case</a>(&self, other: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks that two slices are an ASCII case-insensitive match.</p>
|
|||
|
|
<p>Same as <code>to_ascii_lowercase(a) == to_ascii_lowercase(b)</code>,
|
|||
|
|
but without allocating and copying temporaries.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.make_ascii_uppercase" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/ascii.rs.html#72">source</a></span><h4 class="code-header">pub fn <a href="#method.make_ascii_uppercase" class="fn">make_ascii_uppercase</a>(&mut self)</h4></section></summary><div class="docblock"><p>Converts this slice to its ASCII upper case equivalent in-place.</p>
|
|||
|
|
<p>ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’,
|
|||
|
|
but non-ASCII letters are unchanged.</p>
|
|||
|
|
<p>To return a new uppercased value without modifying the existing one, use
|
|||
|
|
<a href="#method.to_ascii_uppercase"><code>to_ascii_uppercase</code></a>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.make_ascii_lowercase" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/ascii.rs.html#89">source</a></span><h4 class="code-header">pub fn <a href="#method.make_ascii_lowercase" class="fn">make_ascii_lowercase</a>(&mut self)</h4></section></summary><div class="docblock"><p>Converts this slice to its ASCII lower case equivalent in-place.</p>
|
|||
|
|
<p>ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’,
|
|||
|
|
but non-ASCII letters are unchanged.</p>
|
|||
|
|
<p>To return a new lowercased value without modifying the existing one, use
|
|||
|
|
<a href="#method.to_ascii_lowercase"><code>to_ascii_lowercase</code></a>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.escape_ascii" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.60.0">1.60.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/ascii.rs.html#109">source</a></span><h4 class="code-header">pub fn <a href="#method.escape_ascii" class="fn">escape_ascii</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/ascii/struct.EscapeAscii.html" title="struct core::slice::ascii::EscapeAscii">EscapeAscii</a><'_></h4></section></summary><div class="docblock"><p>Returns an iterator that produces an escaped version of this slice,
|
|||
|
|
treating it as an ASCII string.</p>
|
|||
|
|
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
|
|||
|
|
<span class="kw">let </span>s = <span class="string">b"0\t\r\n'\"\\\x9d"</span>;
|
|||
|
|
<span class="kw">let </span>escaped = s.escape_ascii().to_string();
|
|||
|
|
<span class="macro">assert_eq!</span>(escaped, <span class="string">"0\\t\\r\\n\\'\\\"\\\\\\x9d"</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.trim_ascii_start" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/ascii.rs.html#129">source</a><h4 class="code-header">pub fn <a href="#method.trim_ascii_start" class="fn">trim_ascii_start</a>(&self) -> &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>byte_slice_trim_ascii</code>)</span></div></span></summary><div class="docblock"><p>Returns a byte slice with leading ASCII whitespace bytes removed.</p>
|
|||
|
|
<p>‘Whitespace’ refers to the definition used by
|
|||
|
|
<code>u8::is_ascii_whitespace</code>.</p>
|
|||
|
|
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(byte_slice_trim_ascii)]
|
|||
|
|
|
|||
|
|
</span><span class="macro">assert_eq!</span>(<span class="string">b" \t hello world\n"</span>.trim_ascii_start(), <span class="string">b"hello world\n"</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="string">b" "</span>.trim_ascii_start(), <span class="string">b""</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="string">b""</span>.trim_ascii_start(), <span class="string">b""</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.trim_ascii_end" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/ascii.rs.html#159">source</a><h4 class="code-header">pub fn <a href="#method.trim_ascii_end" class="fn">trim_ascii_end</a>(&self) -> &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>byte_slice_trim_ascii</code>)</span></div></span></summary><div class="docblock"><p>Returns a byte slice with trailing ASCII whitespace bytes removed.</p>
|
|||
|
|
<p>‘Whitespace’ refers to the definition used by
|
|||
|
|
<code>u8::is_ascii_whitespace</code>.</p>
|
|||
|
|
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(byte_slice_trim_ascii)]
|
|||
|
|
|
|||
|
|
</span><span class="macro">assert_eq!</span>(<span class="string">b"\r hello world\n "</span>.trim_ascii_end(), <span class="string">b"\r hello world"</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="string">b" "</span>.trim_ascii_end(), <span class="string">b""</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="string">b""</span>.trim_ascii_end(), <span class="string">b""</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.trim_ascii" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/ascii.rs.html#190">source</a><h4 class="code-header">pub fn <a href="#method.trim_ascii" class="fn">trim_ascii</a>(&self) -> &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>byte_slice_trim_ascii</code>)</span></div></span></summary><div class="docblock"><p>Returns a byte slice with leading and trailing ASCII whitespace bytes
|
|||
|
|
removed.</p>
|
|||
|
|
<p>‘Whitespace’ refers to the definition used by
|
|||
|
|
<code>u8::is_ascii_whitespace</code>.</p>
|
|||
|
|
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(byte_slice_trim_ascii)]
|
|||
|
|
|
|||
|
|
</span><span class="macro">assert_eq!</span>(<span class="string">b"\r hello world\n "</span>.trim_ascii(), <span class="string">b"hello world"</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="string">b" "</span>.trim_ascii(), <span class="string">b""</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="string">b""</span>.trim_ascii(), <span class="string">b""</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.len-1" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#137">source</a></span><h4 class="code-header">pub fn <a href="#method.len-1" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of elements in the slice.</p>
|
|||
|
|
<h5 id="examples-5"><a href="#examples-5">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>a = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(a.len(), <span class="number">3</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty-1" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#153">source</a></span><h4 class="code-header">pub fn <a href="#method.is_empty-1" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the slice has a length of 0.</p>
|
|||
|
|
<h5 id="examples-6"><a href="#examples-6">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>a = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|||
|
|
<span class="macro">assert!</span>(!a.is_empty());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.first" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#172">source</a></span><h4 class="code-header">pub fn <a href="#method.first" class="fn">first</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns the first element of the slice, or <code>None</code> if it is empty.</p>
|
|||
|
|
<h5 id="examples-7"><a href="#examples-7">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">10</span>), v.first());
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>w: <span class="kw-2">&</span>[i32] = <span class="kw-2">&</span>[];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, w.first());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.first_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#192">source</a></span><h4 class="code-header">pub fn <a href="#method.first_mut" class="fn">first_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>></h4></section></summary><div class="docblock"><p>Returns a mutable pointer to the first element of the slice, or <code>None</code> if it is empty.</p>
|
|||
|
|
<h5 id="examples-8"><a href="#examples-8">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>(first) = x.first_mut() {
|
|||
|
|
<span class="kw-2">*</span>first = <span class="number">5</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">5</span>, <span class="number">1</span>, <span class="number">2</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_first" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.5.0">1.5.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#212">source</a></span><h4 class="code-header">pub fn <a href="#method.split_first" class="fn">split_first</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)></h4></section></summary><div class="docblock"><p>Returns the first and all the rest of the elements of the slice, or <code>None</code> if it is empty.</p>
|
|||
|
|
<h5 id="examples-9"><a href="#examples-9">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>((first, elements)) = x.split_first() {
|
|||
|
|
<span class="macro">assert_eq!</span>(first, <span class="kw-2">&</span><span class="number">0</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(elements, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>]);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_first_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.5.0">1.5.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#234">source</a></span><h4 class="code-header">pub fn <a href="#method.split_first_mut" class="fn">split_first_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)></h4></section></summary><div class="docblock"><p>Returns the first and all the rest of the elements of the slice, or <code>None</code> if it is empty.</p>
|
|||
|
|
<h5 id="examples-10"><a href="#examples-10">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>((first, elements)) = x.split_first_mut() {
|
|||
|
|
<span class="kw-2">*</span>first = <span class="number">3</span>;
|
|||
|
|
elements[<span class="number">0</span>] = <span class="number">4</span>;
|
|||
|
|
elements[<span class="number">1</span>] = <span class="number">5</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_last" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.5.0">1.5.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#254">source</a></span><h4 class="code-header">pub fn <a href="#method.split_last" class="fn">split_last</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)></h4></section></summary><div class="docblock"><p>Returns the last and all the rest of the elements of the slice, or <code>None</code> if it is empty.</p>
|
|||
|
|
<h5 id="examples-11"><a href="#examples-11">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>((last, elements)) = x.split_last() {
|
|||
|
|
<span class="macro">assert_eq!</span>(last, <span class="kw-2">&</span><span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(elements, <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">1</span>]);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_last_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.5.0">1.5.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#276">source</a></span><h4 class="code-header">pub fn <a href="#method.split_last_mut" class="fn">split_last_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)></h4></section></summary><div class="docblock"><p>Returns the last and all the rest of the elements of the slice, or <code>None</code> if it is empty.</p>
|
|||
|
|
<h5 id="examples-12"><a href="#examples-12">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>((last, elements)) = x.split_last_mut() {
|
|||
|
|
<span class="kw-2">*</span>last = <span class="number">3</span>;
|
|||
|
|
elements[<span class="number">0</span>] = <span class="number">4</span>;
|
|||
|
|
elements[<span class="number">1</span>] = <span class="number">5</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">4</span>, <span class="number">5</span>, <span class="number">3</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.last" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#295">source</a></span><h4 class="code-header">pub fn <a href="#method.last" class="fn">last</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns the last element of the slice, or <code>None</code> if it is empty.</p>
|
|||
|
|
<h5 id="examples-13"><a href="#examples-13">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">30</span>), v.last());
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>w: <span class="kw-2">&</span>[i32] = <span class="kw-2">&</span>[];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, w.last());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.last_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#315">source</a></span><h4 class="code-header">pub fn <a href="#method.last_mut" class="fn">last_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>></h4></section></summary><div class="docblock"><p>Returns a mutable pointer to the last item in the slice.</p>
|
|||
|
|
<h5 id="examples-14"><a href="#examples-14">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>(last) = x.last_mut() {
|
|||
|
|
<span class="kw-2">*</span>last = <span class="number">10</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">10</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.first_chunk" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#338">source</a><h4 class="code-header">pub fn <a href="#method.first_chunk" class="fn">first_chunk</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_first_last_chunk</code>)</span></div></span></summary><div class="docblock"><p>Returns the first <code>N</code> elements of the slice, or <code>None</code> if it has fewer than <code>N</code> elements.</p>
|
|||
|
|
<h5 id="examples-15"><a href="#examples-15">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_first_last_chunk)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>u = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>]), u.first_chunk::<<span class="number">2</span>>());
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>v: <span class="kw-2">&</span>[i32] = <span class="kw-2">&</span>[<span class="number">10</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, v.first_chunk::<<span class="number">2</span>>());
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>w: <span class="kw-2">&</span>[i32] = <span class="kw-2">&</span>[];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span>[]), w.first_chunk::<<span class="number">0</span>>());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.first_chunk_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#367">source</a><h4 class="code-header">pub fn <a href="#method.first_chunk_mut" class="fn">first_chunk_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_first_last_chunk</code>)</span></div></span></summary><div class="docblock"><p>Returns a mutable reference to the first <code>N</code> elements of the slice,
|
|||
|
|
or <code>None</code> if it has fewer than <code>N</code> elements.</p>
|
|||
|
|
<h5 id="examples-16"><a href="#examples-16">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_first_last_chunk)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>(first) = x.first_chunk_mut::<<span class="number">2</span>>() {
|
|||
|
|
first[<span class="number">0</span>] = <span class="number">5</span>;
|
|||
|
|
first[<span class="number">1</span>] = <span class="number">4</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">5</span>, <span class="number">4</span>, <span class="number">2</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_first_chunk" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#396">source</a><h4 class="code-header">pub fn <a href="#method.split_first_chunk" class="fn">split_first_chunk</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_first_last_chunk</code>)</span></div></span></summary><div class="docblock"><p>Returns the first <code>N</code> elements of the slice and the remainder,
|
|||
|
|
or <code>None</code> if it has fewer than <code>N</code> elements.</p>
|
|||
|
|
<h5 id="examples-17"><a href="#examples-17">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_first_last_chunk)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>x = <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>((first, elements)) = x.split_first_chunk::<<span class="number">2</span>>() {
|
|||
|
|
<span class="macro">assert_eq!</span>(first, <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">1</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(elements, <span class="kw-2">&</span>[<span class="number">2</span>]);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_first_chunk_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#429-431">source</a><h4 class="code-header">pub fn <a href="#method.split_first_chunk_mut" class="fn">split_first_chunk_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(
|
|||
|
|
&mut self
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_first_last_chunk</code>)</span></div></span></summary><div class="docblock"><p>Returns a mutable reference to the first <code>N</code> elements of the slice and the remainder,
|
|||
|
|
or <code>None</code> if it has fewer than <code>N</code> elements.</p>
|
|||
|
|
<h5 id="examples-18"><a href="#examples-18">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_first_last_chunk)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>((first, elements)) = x.split_first_chunk_mut::<<span class="number">2</span>>() {
|
|||
|
|
first[<span class="number">0</span>] = <span class="number">3</span>;
|
|||
|
|
first[<span class="number">1</span>] = <span class="number">4</span>;
|
|||
|
|
elements[<span class="number">0</span>] = <span class="number">5</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_last_chunk" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#463">source</a><h4 class="code-header">pub fn <a href="#method.split_last_chunk" class="fn">split_last_chunk</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_first_last_chunk</code>)</span></div></span></summary><div class="docblock"><p>Returns the last <code>N</code> elements of the slice and the remainder,
|
|||
|
|
or <code>None</code> if it has fewer than <code>N</code> elements.</p>
|
|||
|
|
<h5 id="examples-19"><a href="#examples-19">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_first_last_chunk)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>x = <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>((last, elements)) = x.split_last_chunk::<<span class="number">2</span>>() {
|
|||
|
|
<span class="macro">assert_eq!</span>(last, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(elements, <span class="kw-2">&</span>[<span class="number">0</span>]);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_last_chunk_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#495-497">source</a><h4 class="code-header">pub fn <a href="#method.split_last_chunk_mut" class="fn">split_last_chunk_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(
|
|||
|
|
&mut self
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_first_last_chunk</code>)</span></div></span></summary><div class="docblock"><p>Returns the last and all the rest of the elements of the slice, or <code>None</code> if it is empty.</p>
|
|||
|
|
<h5 id="examples-20"><a href="#examples-20">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_first_last_chunk)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>((last, elements)) = x.split_last_chunk_mut::<<span class="number">2</span>>() {
|
|||
|
|
last[<span class="number">0</span>] = <span class="number">3</span>;
|
|||
|
|
last[<span class="number">1</span>] = <span class="number">4</span>;
|
|||
|
|
elements[<span class="number">0</span>] = <span class="number">5</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">5</span>, <span class="number">3</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.last_chunk" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#530">source</a><h4 class="code-header">pub fn <a href="#method.last_chunk" class="fn">last_chunk</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_first_last_chunk</code>)</span></div></span></summary><div class="docblock"><p>Returns the last element of the slice, or <code>None</code> if it is empty.</p>
|
|||
|
|
<h5 id="examples-21"><a href="#examples-21">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_first_last_chunk)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>u = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">40</span>, <span class="number">30</span>]), u.last_chunk::<<span class="number">2</span>>());
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>v: <span class="kw-2">&</span>[i32] = <span class="kw-2">&</span>[<span class="number">10</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, v.last_chunk::<<span class="number">2</span>>());
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>w: <span class="kw-2">&</span>[i32] = <span class="kw-2">&</span>[];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span>[]), w.last_chunk::<<span class="number">0</span>>());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.last_chunk_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#562">source</a><h4 class="code-header">pub fn <a href="#method.last_chunk_mut" class="fn">last_chunk_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_first_last_chunk</code>)</span></div></span></summary><div class="docblock"><p>Returns a mutable pointer to the last item in the slice.</p>
|
|||
|
|
<h5 id="examples-22"><a href="#examples-22">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_first_last_chunk)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>(last) = x.last_chunk_mut::<<span class="number">2</span>>() {
|
|||
|
|
last[<span class="number">0</span>] = <span class="number">10</span>;
|
|||
|
|
last[<span class="number">1</span>] = <span class="number">20</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">10</span>, <span class="number">20</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#597-599">source</a></span><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a><I>(&self, index: I) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<I as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html#associatedtype.Output" title="type core::slice::index::SliceIndex::Output">Output</a>><div class="where">where
|
|||
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>>,</div></h4></section></summary><div class="docblock"><p>Returns a reference to an element or subslice depending on the type of
|
|||
|
|
index.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>If given a position, returns a reference to the element at that
|
|||
|
|
position or <code>None</code> if out of bounds.</li>
|
|||
|
|
<li>If given a range, returns the subslice corresponding to that range,
|
|||
|
|
or <code>None</code> if out of bounds.</li>
|
|||
|
|
</ul>
|
|||
|
|
<h5 id="examples-23"><a href="#examples-23">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">40</span>), v.get(<span class="number">1</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>][..]), v.get(<span class="number">0</span>..<span class="number">2</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, v.get(<span class="number">3</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, v.get(<span class="number">0</span>..<span class="number">4</span>));</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#622-624">source</a></span><h4 class="code-header">pub fn <a href="#method.get_mut" class="fn">get_mut</a><I>(
|
|||
|
|
&mut self,
|
|||
|
|
index: I
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut <I as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html#associatedtype.Output" title="type core::slice::index::SliceIndex::Output">Output</a>><div class="where">where
|
|||
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>>,</div></h4></section></summary><div class="docblock"><p>Returns a mutable reference to an element or subslice depending on the
|
|||
|
|
type of index (see <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.get" title="method slice::get"><code>get</code></a>) or <code>None</code> if the index is out of bounds.</p>
|
|||
|
|
<h5 id="examples-24"><a href="#examples-24">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>(elem) = x.get_mut(<span class="number">1</span>) {
|
|||
|
|
<span class="kw-2">*</span>elem = <span class="number">42</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">42</span>, <span class="number">2</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_unchecked" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#659-661">source</a></span><h4 class="code-header">pub unsafe fn <a href="#method.get_unchecked" class="fn">get_unchecked</a><I>(
|
|||
|
|
&self,
|
|||
|
|
index: I
|
|||
|
|
) -> &<I as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html#associatedtype.Output" title="type core::slice::index::SliceIndex::Output">Output</a><div class="where">where
|
|||
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>>,</div></h4></section></summary><div class="docblock"><p>Returns a reference to an element or subslice, without doing bounds
|
|||
|
|
checking.</p>
|
|||
|
|
<p>For a safe alternative see <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.get" title="method slice::get"><code>get</code></a>.</p>
|
|||
|
|
<h5 id="safety-2"><a href="#safety-2">Safety</a></h5>
|
|||
|
|
<p>Calling this method with an out-of-bounds index is <em><a href="https://doc.rust-lang.org/reference/behavior-considered-undefined.html">undefined behavior</a></em>
|
|||
|
|
even if the resulting reference is not used.</p>
|
|||
|
|
<p>You can think of this like <code>.get(index).unwrap_unchecked()</code>. It’s UB
|
|||
|
|
to call <code>.get_unchecked(len)</code>, even if you immediately convert to a
|
|||
|
|
pointer. And it’s UB to call <code>.get_unchecked(..len + 1)</code>,
|
|||
|
|
<code>.get_unchecked(..=len)</code>, or similar.</p>
|
|||
|
|
<h5 id="examples-25"><a href="#examples-25">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">unsafe </span>{
|
|||
|
|
<span class="macro">assert_eq!</span>(x.get_unchecked(<span class="number">1</span>), <span class="kw-2">&</span><span class="number">2</span>);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_unchecked_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#701-703">source</a></span><h4 class="code-header">pub unsafe fn <a href="#method.get_unchecked_mut" class="fn">get_unchecked_mut</a><I>(
|
|||
|
|
&mut self,
|
|||
|
|
index: I
|
|||
|
|
) -> &mut <I as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html#associatedtype.Output" title="type core::slice::index::SliceIndex::Output">Output</a><div class="where">where
|
|||
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>>,</div></h4></section></summary><div class="docblock"><p>Returns a mutable reference to an element or subslice, without doing
|
|||
|
|
bounds checking.</p>
|
|||
|
|
<p>For a safe alternative see <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.get_mut" title="method slice::get_mut"><code>get_mut</code></a>.</p>
|
|||
|
|
<h5 id="safety-3"><a href="#safety-3">Safety</a></h5>
|
|||
|
|
<p>Calling this method with an out-of-bounds index is <em><a href="https://doc.rust-lang.org/reference/behavior-considered-undefined.html">undefined behavior</a></em>
|
|||
|
|
even if the resulting reference is not used.</p>
|
|||
|
|
<p>You can think of this like <code>.get_mut(index).unwrap_unchecked()</code>. It’s
|
|||
|
|
UB to call <code>.get_unchecked_mut(len)</code>, even if you immediately convert
|
|||
|
|
to a pointer. And it’s UB to call <code>.get_unchecked_mut(..len + 1)</code>,
|
|||
|
|
<code>.get_unchecked_mut(..=len)</code>, or similar.</p>
|
|||
|
|
<h5 id="examples-26"><a href="#examples-26">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">unsafe </span>{
|
|||
|
|
<span class="kw">let </span>elem = x.get_unchecked_mut(<span class="number">1</span>);
|
|||
|
|
<span class="kw-2">*</span>elem = <span class="number">13</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">13</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_ptr-1" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#742">source</a></span><h4 class="code-header">pub fn <a href="#method.as_ptr-1" class="fn">as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.pointer.html">*const T</a></h4></section></summary><div class="docblock"><p>Returns a raw pointer to the slice’s buffer.</p>
|
|||
|
|
<p>The caller must ensure that the slice outlives the pointer this
|
|||
|
|
function returns, or else it will end up pointing to garbage.</p>
|
|||
|
|
<p>The caller must also ensure that the memory the pointer (non-transitively) points to
|
|||
|
|
is never written to (except inside an <code>UnsafeCell</code>) using this pointer or any pointer
|
|||
|
|
derived from it. If you need to mutate the contents of the slice, use <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.as_mut_ptr" title="method slice::as_mut_ptr"><code>as_mut_ptr</code></a>.</p>
|
|||
|
|
<p>Modifying the container referenced by this slice may cause its buffer
|
|||
|
|
to be reallocated, which would also make any pointers to it invalid.</p>
|
|||
|
|
<h5 id="examples-27"><a href="#examples-27">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>];
|
|||
|
|
<span class="kw">let </span>x_ptr = x.as_ptr();
|
|||
|
|
|
|||
|
|
<span class="kw">unsafe </span>{
|
|||
|
|
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..x.len() {
|
|||
|
|
<span class="macro">assert_eq!</span>(x.get_unchecked(i), <span class="kw-2">&*</span>x_ptr.add(i));
|
|||
|
|
}
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_mut_ptr-1" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#773">source</a></span><h4 class="code-header">pub fn <a href="#method.as_mut_ptr-1" class="fn">as_mut_ptr</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.pointer.html">*mut T</a></h4></section></summary><div class="docblock"><p>Returns an unsafe mutable pointer to the slice’s buffer.</p>
|
|||
|
|
<p>The caller must ensure that the slice outlives the pointer this
|
|||
|
|
function returns, or else it will end up pointing to garbage.</p>
|
|||
|
|
<p>Modifying the container referenced by this slice may cause its buffer
|
|||
|
|
to be reallocated, which would also make any pointers to it invalid.</p>
|
|||
|
|
<h5 id="examples-28"><a href="#examples-28">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>];
|
|||
|
|
<span class="kw">let </span>x_ptr = x.as_mut_ptr();
|
|||
|
|
|
|||
|
|
<span class="kw">unsafe </span>{
|
|||
|
|
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..x.len() {
|
|||
|
|
<span class="kw-2">*</span>x_ptr.add(i) += <span class="number">2</span>;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">6</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_ptr_range" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.48.0">1.48.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#809">source</a></span><h4 class="code-header">pub fn <a href="#method.as_ptr_range" class="fn">as_ptr_range</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.pointer.html">*const T</a>></h4></section></summary><div class="docblock"><p>Returns the two raw pointers spanning the slice.</p>
|
|||
|
|
<p>The returned range is half-open, which means that the end pointer
|
|||
|
|
points <em>one past</em> the last element of the slice. This way, an empty
|
|||
|
|
slice is represented by two equal pointers, and the difference between
|
|||
|
|
the two pointers represents the size of the slice.</p>
|
|||
|
|
<p>See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.as_ptr" title="method slice::as_ptr"><code>as_ptr</code></a> for warnings on using these pointers. The end pointer
|
|||
|
|
requires extra caution, as it does not point to a valid element in the
|
|||
|
|
slice.</p>
|
|||
|
|
<p>This function is useful for interacting with foreign interfaces which
|
|||
|
|
use two pointers to refer to a range of elements in memory, as is
|
|||
|
|
common in C++.</p>
|
|||
|
|
<p>It can also be useful to check if a pointer to an element refers to an
|
|||
|
|
element of this slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>a = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|||
|
|
<span class="kw">let </span>x = <span class="kw-2">&</span>a[<span class="number">1</span>] <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>;
|
|||
|
|
<span class="kw">let </span>y = <span class="kw-2">&</span><span class="number">5 </span><span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>;
|
|||
|
|
|
|||
|
|
<span class="macro">assert!</span>(a.as_ptr_range().contains(<span class="kw-2">&</span>x));
|
|||
|
|
<span class="macro">assert!</span>(!a.as_ptr_range().contains(<span class="kw-2">&</span>y));</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_mut_ptr_range" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.48.0">1.48.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#853">source</a></span><h4 class="code-header">pub fn <a href="#method.as_mut_ptr_range" class="fn">as_mut_ptr_range</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.pointer.html">*mut T</a>></h4></section></summary><div class="docblock"><p>Returns the two unsafe mutable pointers spanning the slice.</p>
|
|||
|
|
<p>The returned range is half-open, which means that the end pointer
|
|||
|
|
points <em>one past</em> the last element of the slice. This way, an empty
|
|||
|
|
slice is represented by two equal pointers, and the difference between
|
|||
|
|
the two pointers represents the size of the slice.</p>
|
|||
|
|
<p>See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.as_mut_ptr" title="method slice::as_mut_ptr"><code>as_mut_ptr</code></a> for warnings on using these pointers. The end
|
|||
|
|
pointer requires extra caution, as it does not point to a valid element
|
|||
|
|
in the slice.</p>
|
|||
|
|
<p>This function is useful for interacting with foreign interfaces which
|
|||
|
|
use two pointers to refer to a range of elements in memory, as is
|
|||
|
|
common in C++.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.swap" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#884">source</a></span><h4 class="code-header">pub fn <a href="#method.swap" class="fn">swap</a>(&mut self, a: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, b: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Swaps two elements in the slice.</p>
|
|||
|
|
<p>If <code>a</code> equals to <code>b</code>, it’s guaranteed that elements won’t change value.</p>
|
|||
|
|
<h5 id="arguments"><a href="#arguments">Arguments</a></h5>
|
|||
|
|
<ul>
|
|||
|
|
<li>a - The index of the first element</li>
|
|||
|
|
<li>b - The index of the second element</li>
|
|||
|
|
</ul>
|
|||
|
|
<h5 id="panics-1"><a href="#panics-1">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>a</code> or <code>b</code> are out of bounds.</p>
|
|||
|
|
<h5 id="examples-29"><a href="#examples-29">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="string">"a"</span>, <span class="string">"b"</span>, <span class="string">"c"</span>, <span class="string">"d"</span>, <span class="string">"e"</span>];
|
|||
|
|
v.swap(<span class="number">2</span>, <span class="number">4</span>);
|
|||
|
|
<span class="macro">assert!</span>(v == [<span class="string">"a"</span>, <span class="string">"b"</span>, <span class="string">"e"</span>, <span class="string">"d"</span>, <span class="string">"c"</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.swap_unchecked" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#927">source</a><h4 class="code-header">pub unsafe fn <a href="#method.swap_unchecked" class="fn">swap_unchecked</a>(&mut self, a: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, b: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_swap_unchecked</code>)</span></div></span></summary><div class="docblock"><p>Swaps two elements in the slice, without doing bounds checking.</p>
|
|||
|
|
<p>For a safe alternative see <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.swap" title="method slice::swap"><code>swap</code></a>.</p>
|
|||
|
|
<h5 id="arguments-1"><a href="#arguments-1">Arguments</a></h5>
|
|||
|
|
<ul>
|
|||
|
|
<li>a - The index of the first element</li>
|
|||
|
|
<li>b - The index of the second element</li>
|
|||
|
|
</ul>
|
|||
|
|
<h5 id="safety-4"><a href="#safety-4">Safety</a></h5>
|
|||
|
|
<p>Calling this method with an out-of-bounds index is <em><a href="https://doc.rust-lang.org/reference/behavior-considered-undefined.html">undefined behavior</a></em>.
|
|||
|
|
The caller has to ensure that <code>a < self.len()</code> and <code>b < self.len()</code>.</p>
|
|||
|
|
<h5 id="examples-30"><a href="#examples-30">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_swap_unchecked)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="string">"a"</span>, <span class="string">"b"</span>, <span class="string">"c"</span>, <span class="string">"d"</span>];
|
|||
|
|
<span class="comment">// SAFETY: we know that 1 and 3 are both indices of the slice
|
|||
|
|
</span><span class="kw">unsafe </span>{ v.swap_unchecked(<span class="number">1</span>, <span class="number">3</span>) };
|
|||
|
|
<span class="macro">assert!</span>(v == [<span class="string">"a"</span>, <span class="string">"d"</span>, <span class="string">"c"</span>, <span class="string">"b"</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.reverse" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#951">source</a></span><h4 class="code-header">pub fn <a href="#method.reverse" class="fn">reverse</a>(&mut self)</h4></section></summary><div class="docblock"><p>Reverses the order of elements in the slice, in place.</p>
|
|||
|
|
<h5 id="examples-31"><a href="#examples-31">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|||
|
|
v.reverse();
|
|||
|
|
<span class="macro">assert!</span>(v == [<span class="number">3</span>, <span class="number">2</span>, <span class="number">1</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1009">source</a></span><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.Iter.html" title="struct core::slice::iter::Iter">Iter</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator over the slice.</p>
|
|||
|
|
<p>The iterator yields all items from start to end.</p>
|
|||
|
|
<h5 id="examples-32"><a href="#examples-32">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iterator = x.iter();
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iterator.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">1</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(iterator.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">2</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(iterator.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">4</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(iterator.next(), <span class="prelude-val">None</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1028">source</a></span><h4 class="code-header">pub fn <a href="#method.iter_mut" class="fn">iter_mut</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.IterMut.html" title="struct core::slice::iter::IterMut">IterMut</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator that allows modifying each value.</p>
|
|||
|
|
<p>The iterator yields all items from start to end.</p>
|
|||
|
|
<h5 id="examples-33"><a href="#examples-33">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>];
|
|||
|
|
<span class="kw">for </span>elem <span class="kw">in </span>x.iter_mut() {
|
|||
|
|
<span class="kw-2">*</span>elem += <span class="number">2</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">6</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.windows" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1077">source</a></span><h4 class="code-header">pub fn <a href="#method.windows" class="fn">windows</a>(&self, size: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.Windows.html" title="struct core::slice::iter::Windows">Windows</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator over all contiguous windows of length
|
|||
|
|
<code>size</code>. The windows overlap. If the slice is shorter than
|
|||
|
|
<code>size</code>, the iterator returns no values.</p>
|
|||
|
|
<h5 id="panics-2"><a href="#panics-2">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>size</code> is 0.</p>
|
|||
|
|
<h5 id="examples-34"><a href="#examples-34">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.windows(<span class="number">3</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());</code></pre></div>
|
|||
|
|
<p>If the slice is shorter than <code>size</code>:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="string">'f'</span>, <span class="string">'o'</span>, <span class="string">'o'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.windows(<span class="number">4</span>);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());</code></pre></div>
|
|||
|
|
<p>There’s no <code>windows_mut</code>, as that existing would let safe code violate the
|
|||
|
|
“only one <code>&mut</code> at a time to the same thing” rule. However, you can sometimes
|
|||
|
|
use <a href="https://doc.rust-lang.org/1.76.0/core/cell/struct.Cell.html#method.as_slice_of_cells" title="method core::cell::Cell::as_slice_of_cells"><code>Cell::as_slice_of_cells</code></a> in
|
|||
|
|
conjunction with <code>windows</code> to accomplish something similar:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::cell::Cell;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>array = [<span class="string">'R'</span>, <span class="string">'u'</span>, <span class="string">'s'</span>, <span class="string">'t'</span>, <span class="string">' '</span>, <span class="string">'2'</span>, <span class="string">'0'</span>, <span class="string">'1'</span>, <span class="string">'5'</span>];
|
|||
|
|
<span class="kw">let </span>slice = <span class="kw-2">&mut </span>array[..];
|
|||
|
|
<span class="kw">let </span>slice_of_cells: <span class="kw-2">&</span>[Cell<char>] = Cell::from_mut(slice).as_slice_of_cells();
|
|||
|
|
<span class="kw">for </span>w <span class="kw">in </span>slice_of_cells.windows(<span class="number">3</span>) {
|
|||
|
|
Cell::swap(<span class="kw-2">&</span>w[<span class="number">0</span>], <span class="kw-2">&</span>w[<span class="number">2</span>]);
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(array, [<span class="string">'s'</span>, <span class="string">'t'</span>, <span class="string">' '</span>, <span class="string">'2'</span>, <span class="string">'0'</span>, <span class="string">'1'</span>, <span class="string">'5'</span>, <span class="string">'u'</span>, <span class="string">'R'</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.chunks" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1112">source</a></span><h4 class="code-header">pub fn <a href="#method.chunks" class="fn">chunks</a>(&self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.Chunks.html" title="struct core::slice::iter::Chunks">Chunks</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator over <code>chunk_size</code> elements of the slice at a time, starting at the
|
|||
|
|
beginning of the slice.</p>
|
|||
|
|
<p>The chunks are slices and do not overlap. If <code>chunk_size</code> does not divide the length of the
|
|||
|
|
slice, then the last chunk will not have length <code>chunk_size</code>.</p>
|
|||
|
|
<p>See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks_exact" title="method slice::chunks_exact"><code>chunks_exact</code></a> for a variant of this iterator that returns chunks of always exactly
|
|||
|
|
<code>chunk_size</code> elements, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.rchunks" title="method slice::rchunks"><code>rchunks</code></a> for the same iterator but starting at the end of the
|
|||
|
|
slice.</p>
|
|||
|
|
<h5 id="panics-3"><a href="#panics-3">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>chunk_size</code> is 0.</p>
|
|||
|
|
<h5 id="examples-35"><a href="#examples-35">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.chunks(<span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'l'</span>, <span class="string">'o'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'r'</span>, <span class="string">'e'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'m'</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.chunks_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1151">source</a></span><h4 class="code-header">pub fn <a href="#method.chunks_mut" class="fn">chunks_mut</a>(&mut self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.ChunksMut.html" title="struct core::slice::iter::ChunksMut">ChunksMut</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator over <code>chunk_size</code> elements of the slice at a time, starting at the
|
|||
|
|
beginning of the slice.</p>
|
|||
|
|
<p>The chunks are mutable slices, and do not overlap. If <code>chunk_size</code> does not divide the
|
|||
|
|
length of the slice, then the last chunk will not have length <code>chunk_size</code>.</p>
|
|||
|
|
<p>See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks_exact_mut" title="method slice::chunks_exact_mut"><code>chunks_exact_mut</code></a> for a variant of this iterator that returns chunks of always
|
|||
|
|
exactly <code>chunk_size</code> elements, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.rchunks_mut" title="method slice::rchunks_mut"><code>rchunks_mut</code></a> for the same iterator but starting at
|
|||
|
|
the end of the slice.</p>
|
|||
|
|
<h5 id="panics-4"><a href="#panics-4">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>chunk_size</code> is 0.</p>
|
|||
|
|
<h5 id="examples-36"><a href="#examples-36">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">1</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>chunk <span class="kw">in </span>v.chunks_mut(<span class="number">2</span>) {
|
|||
|
|
<span class="kw">for </span>elem <span class="kw">in </span>chunk.iter_mut() {
|
|||
|
|
<span class="kw-2">*</span>elem += count;
|
|||
|
|
}
|
|||
|
|
count += <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">3</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.chunks_exact" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.31.0">1.31.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1189">source</a></span><h4 class="code-header">pub fn <a href="#method.chunks_exact" class="fn">chunks_exact</a>(&self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.ChunksExact.html" title="struct core::slice::iter::ChunksExact">ChunksExact</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator over <code>chunk_size</code> elements of the slice at a time, starting at the
|
|||
|
|
beginning of the slice.</p>
|
|||
|
|
<p>The chunks are slices and do not overlap. If <code>chunk_size</code> does not divide the length of the
|
|||
|
|
slice, then the last up to <code>chunk_size-1</code> elements will be omitted and can be retrieved
|
|||
|
|
from the <code>remainder</code> function of the iterator.</p>
|
|||
|
|
<p>Due to each chunk having exactly <code>chunk_size</code> elements, the compiler can often optimize the
|
|||
|
|
resulting code better than in the case of <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks" title="method slice::chunks"><code>chunks</code></a>.</p>
|
|||
|
|
<p>See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks" title="method slice::chunks"><code>chunks</code></a> for a variant of this iterator that also returns the remainder as a smaller
|
|||
|
|
chunk, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.rchunks_exact" title="method slice::rchunks_exact"><code>rchunks_exact</code></a> for the same iterator but starting at the end of the slice.</p>
|
|||
|
|
<h5 id="panics-5"><a href="#panics-5">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>chunk_size</code> is 0.</p>
|
|||
|
|
<h5 id="examples-37"><a href="#examples-37">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.chunks_exact(<span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'l'</span>, <span class="string">'o'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'r'</span>, <span class="string">'e'</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.remainder(), <span class="kw-2">&</span>[<span class="string">'m'</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.chunks_exact_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.31.0">1.31.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1232">source</a></span><h4 class="code-header">pub fn <a href="#method.chunks_exact_mut" class="fn">chunks_exact_mut</a>(&mut self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.ChunksExactMut.html" title="struct core::slice::iter::ChunksExactMut">ChunksExactMut</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator over <code>chunk_size</code> elements of the slice at a time, starting at the
|
|||
|
|
beginning of the slice.</p>
|
|||
|
|
<p>The chunks are mutable slices, and do not overlap. If <code>chunk_size</code> does not divide the
|
|||
|
|
length of the slice, then the last up to <code>chunk_size-1</code> elements will be omitted and can be
|
|||
|
|
retrieved from the <code>into_remainder</code> function of the iterator.</p>
|
|||
|
|
<p>Due to each chunk having exactly <code>chunk_size</code> elements, the compiler can often optimize the
|
|||
|
|
resulting code better than in the case of <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks_mut" title="method slice::chunks_mut"><code>chunks_mut</code></a>.</p>
|
|||
|
|
<p>See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks_mut" title="method slice::chunks_mut"><code>chunks_mut</code></a> for a variant of this iterator that also returns the remainder as a
|
|||
|
|
smaller chunk, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.rchunks_exact_mut" title="method slice::rchunks_exact_mut"><code>rchunks_exact_mut</code></a> for the same iterator but starting at the end of
|
|||
|
|
the slice.</p>
|
|||
|
|
<h5 id="panics-6"><a href="#panics-6">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>chunk_size</code> is 0.</p>
|
|||
|
|
<h5 id="examples-38"><a href="#examples-38">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">1</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>chunk <span class="kw">in </span>v.chunks_exact_mut(<span class="number">2</span>) {
|
|||
|
|
<span class="kw">for </span>elem <span class="kw">in </span>chunk.iter_mut() {
|
|||
|
|
<span class="kw-2">*</span>elem += count;
|
|||
|
|
}
|
|||
|
|
count += <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">0</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_chunks_unchecked" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1267">source</a><h4 class="code-header">pub unsafe fn <a href="#method.as_chunks_unchecked" class="fn">as_chunks_unchecked</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>]</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_as_chunks</code>)</span></div></span></summary><div class="docblock"><p>Splits the slice into a slice of <code>N</code>-element arrays,
|
|||
|
|
assuming that there’s no remainder.</p>
|
|||
|
|
<h5 id="safety-5"><a href="#safety-5">Safety</a></h5>
|
|||
|
|
<p>This may only be called when</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>The slice splits exactly into <code>N</code>-element chunks (aka <code>self.len() % N == 0</code>).</li>
|
|||
|
|
<li><code>N != 0</code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
<h5 id="examples-39"><a href="#examples-39">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_as_chunks)]
|
|||
|
|
</span><span class="kw">let </span>slice: <span class="kw-2">&</span>[char] = <span class="kw-2">&</span>[<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>, <span class="string">'!'</span>];
|
|||
|
|
<span class="kw">let </span>chunks: <span class="kw-2">&</span>[[char; <span class="number">1</span>]] =
|
|||
|
|
<span class="comment">// SAFETY: 1-element chunks never have remainder
|
|||
|
|
</span><span class="kw">unsafe </span>{ slice.as_chunks_unchecked() };
|
|||
|
|
<span class="macro">assert_eq!</span>(chunks, <span class="kw-2">&</span>[[<span class="string">'l'</span>], [<span class="string">'o'</span>], [<span class="string">'r'</span>], [<span class="string">'e'</span>], [<span class="string">'m'</span>], [<span class="string">'!'</span>]]);
|
|||
|
|
<span class="kw">let </span>chunks: <span class="kw-2">&</span>[[char; <span class="number">3</span>]] =
|
|||
|
|
<span class="comment">// SAFETY: The slice length (6) is a multiple of 3
|
|||
|
|
</span><span class="kw">unsafe </span>{ slice.as_chunks_unchecked() };
|
|||
|
|
<span class="macro">assert_eq!</span>(chunks, <span class="kw-2">&</span>[[<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>], [<span class="string">'e'</span>, <span class="string">'m'</span>, <span class="string">'!'</span>]]);
|
|||
|
|
|
|||
|
|
<span class="comment">// These would be unsound:
|
|||
|
|
// let chunks: &[[_; 5]] = slice.as_chunks_unchecked() // The slice length is not a multiple of 5
|
|||
|
|
// let chunks: &[[_; 0]] = slice.as_chunks_unchecked() // Zero-length chunks are never allowed</span></code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_chunks" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1312">source</a><h4 class="code-header">pub fn <a href="#method.as_chunks" class="fn">as_chunks</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> (&[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>], &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_as_chunks</code>)</span></div></span></summary><div class="docblock"><p>Splits the slice into a slice of <code>N</code>-element arrays,
|
|||
|
|
starting at the beginning of the slice,
|
|||
|
|
and a remainder slice with length strictly less than <code>N</code>.</p>
|
|||
|
|
<h5 id="panics-7"><a href="#panics-7">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N</code> is 0. This check will most probably get changed to a compile time
|
|||
|
|
error before this method gets stabilized.</p>
|
|||
|
|
<h5 id="examples-40"><a href="#examples-40">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_as_chunks)]
|
|||
|
|
</span><span class="kw">let </span>slice = [<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>];
|
|||
|
|
<span class="kw">let </span>(chunks, remainder) = slice.as_chunks();
|
|||
|
|
<span class="macro">assert_eq!</span>(chunks, <span class="kw-2">&</span>[[<span class="string">'l'</span>, <span class="string">'o'</span>], [<span class="string">'r'</span>, <span class="string">'e'</span>]]);
|
|||
|
|
<span class="macro">assert_eq!</span>(remainder, <span class="kw-2">&</span>[<span class="string">'m'</span>]);</code></pre></div>
|
|||
|
|
<p>If you expect the slice to be an exact multiple, you can combine
|
|||
|
|
<code>let</code>-<code>else</code> with an empty slice pattern:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_as_chunks)]
|
|||
|
|
</span><span class="kw">let </span>slice = [<span class="string">'R'</span>, <span class="string">'u'</span>, <span class="string">'s'</span>, <span class="string">'t'</span>];
|
|||
|
|
<span class="kw">let </span>(chunks, []) = slice.as_chunks::<<span class="number">2</span>>() <span class="kw">else </span>{
|
|||
|
|
<span class="macro">panic!</span>(<span class="string">"slice didn't have even length"</span>)
|
|||
|
|
};
|
|||
|
|
<span class="macro">assert_eq!</span>(chunks, <span class="kw-2">&</span>[[<span class="string">'R'</span>, <span class="string">'u'</span>], [<span class="string">'s'</span>, <span class="string">'t'</span>]]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_rchunks" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1344">source</a><h4 class="code-header">pub fn <a href="#method.as_rchunks" class="fn">as_rchunks</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> (&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>])</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_as_chunks</code>)</span></div></span></summary><div class="docblock"><p>Splits the slice into a slice of <code>N</code>-element arrays,
|
|||
|
|
starting at the end of the slice,
|
|||
|
|
and a remainder slice with length strictly less than <code>N</code>.</p>
|
|||
|
|
<h5 id="panics-8"><a href="#panics-8">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N</code> is 0. This check will most probably get changed to a compile time
|
|||
|
|
error before this method gets stabilized.</p>
|
|||
|
|
<h5 id="examples-41"><a href="#examples-41">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_as_chunks)]
|
|||
|
|
</span><span class="kw">let </span>slice = [<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>];
|
|||
|
|
<span class="kw">let </span>(remainder, chunks) = slice.as_rchunks();
|
|||
|
|
<span class="macro">assert_eq!</span>(remainder, <span class="kw-2">&</span>[<span class="string">'l'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(chunks, <span class="kw-2">&</span>[[<span class="string">'o'</span>, <span class="string">'r'</span>], [<span class="string">'e'</span>, <span class="string">'m'</span>]]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.array_chunks" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1384">source</a><h4 class="code-header">pub fn <a href="#method.array_chunks" class="fn">array_chunks</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.ArrayChunks.html" title="struct core::slice::iter::ArrayChunks">ArrayChunks</a><'_, T, N></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>array_chunks</code>)</span></div></span></summary><div class="docblock"><p>Returns an iterator over <code>N</code> elements of the slice at a time, starting at the
|
|||
|
|
beginning of the slice.</p>
|
|||
|
|
<p>The chunks are array references and do not overlap. If <code>N</code> does not divide the
|
|||
|
|
length of the slice, then the last up to <code>N-1</code> elements will be omitted and can be
|
|||
|
|
retrieved from the <code>remainder</code> function of the iterator.</p>
|
|||
|
|
<p>This method is the const generic equivalent of <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks_exact" title="method slice::chunks_exact"><code>chunks_exact</code></a>.</p>
|
|||
|
|
<h5 id="panics-9"><a href="#panics-9">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N</code> is 0. This check will most probably get changed to a compile time
|
|||
|
|
error before this method gets stabilized.</p>
|
|||
|
|
<h5 id="examples-42"><a href="#examples-42">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(array_chunks)]
|
|||
|
|
</span><span class="kw">let </span>slice = [<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.array_chunks();
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'l'</span>, <span class="string">'o'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'r'</span>, <span class="string">'e'</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.remainder(), <span class="kw-2">&</span>[<span class="string">'m'</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_chunks_unchecked_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1421">source</a><h4 class="code-header">pub unsafe fn <a href="#method.as_chunks_unchecked_mut" class="fn">as_chunks_unchecked_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(
|
|||
|
|
&mut self
|
|||
|
|
) -> &mut [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>]</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_as_chunks</code>)</span></div></span></summary><div class="docblock"><p>Splits the slice into a slice of <code>N</code>-element arrays,
|
|||
|
|
assuming that there’s no remainder.</p>
|
|||
|
|
<h5 id="safety-6"><a href="#safety-6">Safety</a></h5>
|
|||
|
|
<p>This may only be called when</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>The slice splits exactly into <code>N</code>-element chunks (aka <code>self.len() % N == 0</code>).</li>
|
|||
|
|
<li><code>N != 0</code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
<h5 id="examples-43"><a href="#examples-43">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_as_chunks)]
|
|||
|
|
</span><span class="kw">let </span>slice: <span class="kw-2">&mut </span>[char] = <span class="kw-2">&mut </span>[<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>, <span class="string">'!'</span>];
|
|||
|
|
<span class="kw">let </span>chunks: <span class="kw-2">&mut </span>[[char; <span class="number">1</span>]] =
|
|||
|
|
<span class="comment">// SAFETY: 1-element chunks never have remainder
|
|||
|
|
</span><span class="kw">unsafe </span>{ slice.as_chunks_unchecked_mut() };
|
|||
|
|
chunks[<span class="number">0</span>] = [<span class="string">'L'</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(chunks, <span class="kw-2">&</span>[[<span class="string">'L'</span>], [<span class="string">'o'</span>], [<span class="string">'r'</span>], [<span class="string">'e'</span>], [<span class="string">'m'</span>], [<span class="string">'!'</span>]]);
|
|||
|
|
<span class="kw">let </span>chunks: <span class="kw-2">&mut </span>[[char; <span class="number">3</span>]] =
|
|||
|
|
<span class="comment">// SAFETY: The slice length (6) is a multiple of 3
|
|||
|
|
</span><span class="kw">unsafe </span>{ slice.as_chunks_unchecked_mut() };
|
|||
|
|
chunks[<span class="number">1</span>] = [<span class="string">'a'</span>, <span class="string">'x'</span>, <span class="string">'?'</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, <span class="kw-2">&</span>[<span class="string">'L'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'a'</span>, <span class="string">'x'</span>, <span class="string">'?'</span>]);
|
|||
|
|
|
|||
|
|
<span class="comment">// These would be unsound:
|
|||
|
|
// let chunks: &[[_; 5]] = slice.as_chunks_unchecked_mut() // The slice length is not a multiple of 5
|
|||
|
|
// let chunks: &[[_; 0]] = slice.as_chunks_unchecked_mut() // Zero-length chunks are never allowed</span></code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_chunks_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1461">source</a><h4 class="code-header">pub fn <a href="#method.as_chunks_mut" class="fn">as_chunks_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&mut self) -> (&mut [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>], &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_as_chunks</code>)</span></div></span></summary><div class="docblock"><p>Splits the slice into a slice of <code>N</code>-element arrays,
|
|||
|
|
starting at the beginning of the slice,
|
|||
|
|
and a remainder slice with length strictly less than <code>N</code>.</p>
|
|||
|
|
<h5 id="panics-10"><a href="#panics-10">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N</code> is 0. This check will most probably get changed to a compile time
|
|||
|
|
error before this method gets stabilized.</p>
|
|||
|
|
<h5 id="examples-44"><a href="#examples-44">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_as_chunks)]
|
|||
|
|
</span><span class="kw">let </span>v = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">1</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>(chunks, remainder) = v.as_chunks_mut();
|
|||
|
|
remainder[<span class="number">0</span>] = <span class="number">9</span>;
|
|||
|
|
<span class="kw">for </span>chunk <span class="kw">in </span>chunks {
|
|||
|
|
<span class="kw-2">*</span>chunk = [count; <span class="number">2</span>];
|
|||
|
|
count += <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">9</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_rchunks_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1499">source</a><h4 class="code-header">pub fn <a href="#method.as_rchunks_mut" class="fn">as_rchunks_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&mut self) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &mut [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>])</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_as_chunks</code>)</span></div></span></summary><div class="docblock"><p>Splits the slice into a slice of <code>N</code>-element arrays,
|
|||
|
|
starting at the end of the slice,
|
|||
|
|
and a remainder slice with length strictly less than <code>N</code>.</p>
|
|||
|
|
<h5 id="panics-11"><a href="#panics-11">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N</code> is 0. This check will most probably get changed to a compile time
|
|||
|
|
error before this method gets stabilized.</p>
|
|||
|
|
<h5 id="examples-45"><a href="#examples-45">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_as_chunks)]
|
|||
|
|
</span><span class="kw">let </span>v = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">1</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>(remainder, chunks) = v.as_rchunks_mut();
|
|||
|
|
remainder[<span class="number">0</span>] = <span class="number">9</span>;
|
|||
|
|
<span class="kw">for </span>chunk <span class="kw">in </span>chunks {
|
|||
|
|
<span class="kw-2">*</span>chunk = [count; <span class="number">2</span>];
|
|||
|
|
count += <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, <span class="kw-2">&</span>[<span class="number">9</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">2</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.array_chunks_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1541">source</a><h4 class="code-header">pub fn <a href="#method.array_chunks_mut" class="fn">array_chunks_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.ArrayChunksMut.html" title="struct core::slice::iter::ArrayChunksMut">ArrayChunksMut</a><'_, T, N></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>array_chunks</code>)</span></div></span></summary><div class="docblock"><p>Returns an iterator over <code>N</code> elements of the slice at a time, starting at the
|
|||
|
|
beginning of the slice.</p>
|
|||
|
|
<p>The chunks are mutable array references and do not overlap. If <code>N</code> does not divide
|
|||
|
|
the length of the slice, then the last up to <code>N-1</code> elements will be omitted and
|
|||
|
|
can be retrieved from the <code>into_remainder</code> function of the iterator.</p>
|
|||
|
|
<p>This method is the const generic equivalent of <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks_exact_mut" title="method slice::chunks_exact_mut"><code>chunks_exact_mut</code></a>.</p>
|
|||
|
|
<h5 id="panics-12"><a href="#panics-12">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N</code> is 0. This check will most probably get changed to a compile time
|
|||
|
|
error before this method gets stabilized.</p>
|
|||
|
|
<h5 id="examples-46"><a href="#examples-46">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(array_chunks)]
|
|||
|
|
</span><span class="kw">let </span>v = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">1</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>chunk <span class="kw">in </span>v.array_chunks_mut() {
|
|||
|
|
<span class="kw-2">*</span>chunk = [count; <span class="number">2</span>];
|
|||
|
|
count += <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">0</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.array_windows" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1574">source</a><h4 class="code-header">pub fn <a href="#method.array_windows" class="fn">array_windows</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.ArrayWindows.html" title="struct core::slice::iter::ArrayWindows">ArrayWindows</a><'_, T, N></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>array_windows</code>)</span></div></span></summary><div class="docblock"><p>Returns an iterator over overlapping windows of <code>N</code> elements of a slice,
|
|||
|
|
starting at the beginning of the slice.</p>
|
|||
|
|
<p>This is the const generic equivalent of <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.windows" title="method slice::windows"><code>windows</code></a>.</p>
|
|||
|
|
<p>If <code>N</code> is greater than the size of the slice, it will return no windows.</p>
|
|||
|
|
<h5 id="panics-13"><a href="#panics-13">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N</code> is 0. This check will most probably get changed to a compile time
|
|||
|
|
error before this method gets stabilized.</p>
|
|||
|
|
<h5 id="examples-47"><a href="#examples-47">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(array_windows)]
|
|||
|
|
</span><span class="kw">let </span>slice = [<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.array_windows();
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">1</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">2</span>, <span class="number">3</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rchunks" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.31.0">1.31.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1609">source</a></span><h4 class="code-header">pub fn <a href="#method.rchunks" class="fn">rchunks</a>(&self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.RChunks.html" title="struct core::slice::iter::RChunks">RChunks</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator over <code>chunk_size</code> elements of the slice at a time, starting at the end
|
|||
|
|
of the slice.</p>
|
|||
|
|
<p>The chunks are slices and do not overlap. If <code>chunk_size</code> does not divide the length of the
|
|||
|
|
slice, then the last chunk will not have length <code>chunk_size</code>.</p>
|
|||
|
|
<p>See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.rchunks_exact" title="method slice::rchunks_exact"><code>rchunks_exact</code></a> for a variant of this iterator that returns chunks of always exactly
|
|||
|
|
<code>chunk_size</code> elements, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks" title="method slice::chunks"><code>chunks</code></a> for the same iterator but starting at the beginning
|
|||
|
|
of the slice.</p>
|
|||
|
|
<h5 id="panics-14"><a href="#panics-14">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>chunk_size</code> is 0.</p>
|
|||
|
|
<h5 id="examples-48"><a href="#examples-48">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.rchunks(<span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'e'</span>, <span class="string">'m'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'o'</span>, <span class="string">'r'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'l'</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rchunks_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.31.0">1.31.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1648">source</a></span><h4 class="code-header">pub fn <a href="#method.rchunks_mut" class="fn">rchunks_mut</a>(&mut self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.RChunksMut.html" title="struct core::slice::iter::RChunksMut">RChunksMut</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator over <code>chunk_size</code> elements of the slice at a time, starting at the end
|
|||
|
|
of the slice.</p>
|
|||
|
|
<p>The chunks are mutable slices, and do not overlap. If <code>chunk_size</code> does not divide the
|
|||
|
|
length of the slice, then the last chunk will not have length <code>chunk_size</code>.</p>
|
|||
|
|
<p>See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.rchunks_exact_mut" title="method slice::rchunks_exact_mut"><code>rchunks_exact_mut</code></a> for a variant of this iterator that returns chunks of always
|
|||
|
|
exactly <code>chunk_size</code> elements, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks_mut" title="method slice::chunks_mut"><code>chunks_mut</code></a> for the same iterator but starting at the
|
|||
|
|
beginning of the slice.</p>
|
|||
|
|
<h5 id="panics-15"><a href="#panics-15">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>chunk_size</code> is 0.</p>
|
|||
|
|
<h5 id="examples-49"><a href="#examples-49">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">1</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>chunk <span class="kw">in </span>v.rchunks_mut(<span class="number">2</span>) {
|
|||
|
|
<span class="kw">for </span>elem <span class="kw">in </span>chunk.iter_mut() {
|
|||
|
|
<span class="kw-2">*</span>elem += count;
|
|||
|
|
}
|
|||
|
|
count += <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, <span class="kw-2">&</span>[<span class="number">3</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">1</span>, <span class="number">1</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rchunks_exact" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.31.0">1.31.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1688">source</a></span><h4 class="code-header">pub fn <a href="#method.rchunks_exact" class="fn">rchunks_exact</a>(&self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.RChunksExact.html" title="struct core::slice::iter::RChunksExact">RChunksExact</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator over <code>chunk_size</code> elements of the slice at a time, starting at the
|
|||
|
|
end of the slice.</p>
|
|||
|
|
<p>The chunks are slices and do not overlap. If <code>chunk_size</code> does not divide the length of the
|
|||
|
|
slice, then the last up to <code>chunk_size-1</code> elements will be omitted and can be retrieved
|
|||
|
|
from the <code>remainder</code> function of the iterator.</p>
|
|||
|
|
<p>Due to each chunk having exactly <code>chunk_size</code> elements, the compiler can often optimize the
|
|||
|
|
resulting code better than in the case of <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.rchunks" title="method slice::rchunks"><code>rchunks</code></a>.</p>
|
|||
|
|
<p>See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.rchunks" title="method slice::rchunks"><code>rchunks</code></a> for a variant of this iterator that also returns the remainder as a smaller
|
|||
|
|
chunk, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks_exact" title="method slice::chunks_exact"><code>chunks_exact</code></a> for the same iterator but starting at the beginning of the
|
|||
|
|
slice.</p>
|
|||
|
|
<h5 id="panics-16"><a href="#panics-16">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>chunk_size</code> is 0.</p>
|
|||
|
|
<h5 id="examples-50"><a href="#examples-50">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="string">'l'</span>, <span class="string">'o'</span>, <span class="string">'r'</span>, <span class="string">'e'</span>, <span class="string">'m'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.rchunks_exact(<span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'e'</span>, <span class="string">'m'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="string">'o'</span>, <span class="string">'r'</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.remainder(), <span class="kw-2">&</span>[<span class="string">'l'</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rchunks_exact_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.31.0">1.31.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1732">source</a></span><h4 class="code-header">pub fn <a href="#method.rchunks_exact_mut" class="fn">rchunks_exact_mut</a>(&mut self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.RChunksExactMut.html" title="struct core::slice::iter::RChunksExactMut">RChunksExactMut</a><'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator over <code>chunk_size</code> elements of the slice at a time, starting at the end
|
|||
|
|
of the slice.</p>
|
|||
|
|
<p>The chunks are mutable slices, and do not overlap. If <code>chunk_size</code> does not divide the
|
|||
|
|
length of the slice, then the last up to <code>chunk_size-1</code> elements will be omitted and can be
|
|||
|
|
retrieved from the <code>into_remainder</code> function of the iterator.</p>
|
|||
|
|
<p>Due to each chunk having exactly <code>chunk_size</code> elements, the compiler can often optimize the
|
|||
|
|
resulting code better than in the case of <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks_mut" title="method slice::chunks_mut"><code>chunks_mut</code></a>.</p>
|
|||
|
|
<p>See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.rchunks_mut" title="method slice::rchunks_mut"><code>rchunks_mut</code></a> for a variant of this iterator that also returns the remainder as a
|
|||
|
|
smaller chunk, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.chunks_exact_mut" title="method slice::chunks_exact_mut"><code>chunks_exact_mut</code></a> for the same iterator but starting at the beginning
|
|||
|
|
of the slice.</p>
|
|||
|
|
<h5 id="panics-17"><a href="#panics-17">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>chunk_size</code> is 0.</p>
|
|||
|
|
<h5 id="examples-51"><a href="#examples-51">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = <span class="kw-2">&mut </span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">1</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>chunk <span class="kw">in </span>v.rchunks_exact_mut(<span class="number">2</span>) {
|
|||
|
|
<span class="kw">for </span>elem <span class="kw">in </span>chunk.iter_mut() {
|
|||
|
|
<span class="kw-2">*</span>elem += count;
|
|||
|
|
}
|
|||
|
|
count += <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">1</span>, <span class="number">1</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.group_by" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1775-1777">source</a><h4 class="code-header">pub fn <a href="#method.group_by" class="fn">group_by</a><F>(&self, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.GroupBy.html" title="struct core::slice::iter::GroupBy">GroupBy</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_group_by</code>)</span></div></span></summary><div class="docblock"><p>Returns an iterator over the slice producing non-overlapping runs
|
|||
|
|
of elements using the predicate to separate them.</p>
|
|||
|
|
<p>The predicate is called on two elements following themselves,
|
|||
|
|
it means the predicate is called on <code>slice[0]</code> and <code>slice[1]</code>
|
|||
|
|
then on <code>slice[1]</code> and <code>slice[2]</code> and so on.</p>
|
|||
|
|
<h5 id="examples-52"><a href="#examples-52">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_group_by)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>slice = <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.group_by(|a, b| a == b);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">3</span>, <span class="number">3</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">2</span>, <span class="number">2</span>, <span class="number">2</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">None</span>);</code></pre></div>
|
|||
|
|
<p>This method can be used to extract the sorted subslices:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_group_by)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>slice = <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.group_by(|a, b| a <= b);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">2</span>, <span class="number">3</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">None</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.group_by_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1820-1822">source</a><h4 class="code-header">pub fn <a href="#method.group_by_mut" class="fn">group_by_mut</a><F>(&mut self, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.GroupByMut.html" title="struct core::slice::iter::GroupByMut">GroupByMut</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_group_by</code>)</span></div></span></summary><div class="docblock"><p>Returns an iterator over the slice producing non-overlapping mutable
|
|||
|
|
runs of elements using the predicate to separate them.</p>
|
|||
|
|
<p>The predicate is called on two elements following themselves,
|
|||
|
|
it means the predicate is called on <code>slice[0]</code> and <code>slice[1]</code>
|
|||
|
|
then on <code>slice[1]</code> and <code>slice[2]</code> and so on.</p>
|
|||
|
|
<h5 id="examples-53"><a href="#examples-53">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_group_by)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>slice = <span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.group_by_mut(|a, b| a == b);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&mut </span>[<span class="number">3</span>, <span class="number">3</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&mut </span>[<span class="number">2</span>, <span class="number">2</span>, <span class="number">2</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">None</span>);</code></pre></div>
|
|||
|
|
<p>This method can be used to extract the sorted subslices:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_group_by)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>slice = <span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.group_by_mut(|a, b| a <= b);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&mut </span>[<span class="number">2</span>, <span class="number">3</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="kw-2">&mut </span>[<span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">None</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_at" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1866">source</a></span><h4 class="code-header">pub fn <a href="#method.split_at" class="fn">split_at</a>(&self, mid: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> (&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section></summary><div class="docblock"><p>Divides one slice into two at an index.</p>
|
|||
|
|
<p>The first will contain all indices from <code>[0, mid)</code> (excluding
|
|||
|
|
the index <code>mid</code> itself) and the second will contain all
|
|||
|
|
indices from <code>[mid, len)</code> (excluding the index <code>len</code> itself).</p>
|
|||
|
|
<h5 id="panics-18"><a href="#panics-18">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>mid > len</code>.</p>
|
|||
|
|
<h5 id="examples-54"><a href="#examples-54">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>];
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_at(<span class="number">0</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(left, []);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_at(<span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(left, [<span class="number">1</span>, <span class="number">2</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, [<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_at(<span class="number">6</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(left, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, []);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_at_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1899">source</a></span><h4 class="code-header">pub fn <a href="#method.split_at_mut" class="fn">split_at_mut</a>(&mut self, mid: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section></summary><div class="docblock"><p>Divides one mutable slice into two at an index.</p>
|
|||
|
|
<p>The first will contain all indices from <code>[0, mid)</code> (excluding
|
|||
|
|
the index <code>mid</code> itself) and the second will contain all
|
|||
|
|
indices from <code>[mid, len)</code> (excluding the index <code>len</code> itself).</p>
|
|||
|
|
<h5 id="panics-19"><a href="#panics-19">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>mid > len</code>.</p>
|
|||
|
|
<h5 id="examples-55"><a href="#examples-55">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">0</span>, <span class="number">5</span>, <span class="number">6</span>];
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_at_mut(<span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(left, [<span class="number">1</span>, <span class="number">0</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, [<span class="number">3</span>, <span class="number">0</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
left[<span class="number">1</span>] = <span class="number">2</span>;
|
|||
|
|
right[<span class="number">1</span>] = <span class="number">4</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(v, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_at_unchecked" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#1952">source</a><h4 class="code-header">pub unsafe fn <a href="#method.split_at_unchecked" class="fn">split_at_unchecked</a>(&self, mid: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> (&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_split_at_unchecked</code>)</span></div></span></summary><div class="docblock"><p>Divides one slice into two at an index, without doing bounds checking.</p>
|
|||
|
|
<p>The first will contain all indices from <code>[0, mid)</code> (excluding
|
|||
|
|
the index <code>mid</code> itself) and the second will contain all
|
|||
|
|
indices from <code>[mid, len)</code> (excluding the index <code>len</code> itself).</p>
|
|||
|
|
<p>For a safe alternative see <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.split_at" title="method slice::split_at"><code>split_at</code></a>.</p>
|
|||
|
|
<h5 id="safety-7"><a href="#safety-7">Safety</a></h5>
|
|||
|
|
<p>Calling this method with an out-of-bounds index is <em><a href="https://doc.rust-lang.org/reference/behavior-considered-undefined.html">undefined behavior</a></em>
|
|||
|
|
even if the resulting reference is not used. The caller has to ensure that
|
|||
|
|
<code>0 <= mid <= self.len()</code>.</p>
|
|||
|
|
<h5 id="examples-56"><a href="#examples-56">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_split_at_unchecked)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>v = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">unsafe </span>{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_at_unchecked(<span class="number">0</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(left, []);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">unsafe </span>{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_at_unchecked(<span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(left, [<span class="number">1</span>, <span class="number">2</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, [<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">unsafe </span>{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_at_unchecked(<span class="number">6</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(left, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, []);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_at_mut_unchecked" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2006">source</a><h4 class="code-header">pub unsafe fn <a href="#method.split_at_mut_unchecked" class="fn">split_at_mut_unchecked</a>(
|
|||
|
|
&mut self,
|
|||
|
|
mid: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>
|
|||
|
|
) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_split_at_unchecked</code>)</span></div></span></summary><div class="docblock"><p>Divides one mutable slice into two at an index, without doing bounds checking.</p>
|
|||
|
|
<p>The first will contain all indices from <code>[0, mid)</code> (excluding
|
|||
|
|
the index <code>mid</code> itself) and the second will contain all
|
|||
|
|
indices from <code>[mid, len)</code> (excluding the index <code>len</code> itself).</p>
|
|||
|
|
<p>For a safe alternative see <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.split_at_mut" title="method slice::split_at_mut"><code>split_at_mut</code></a>.</p>
|
|||
|
|
<h5 id="safety-8"><a href="#safety-8">Safety</a></h5>
|
|||
|
|
<p>Calling this method with an out-of-bounds index is <em><a href="https://doc.rust-lang.org/reference/behavior-considered-undefined.html">undefined behavior</a></em>
|
|||
|
|
even if the resulting reference is not used. The caller has to ensure that
|
|||
|
|
<code>0 <= mid <= self.len()</code>.</p>
|
|||
|
|
<h5 id="examples-57"><a href="#examples-57">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_split_at_unchecked)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">0</span>, <span class="number">5</span>, <span class="number">6</span>];
|
|||
|
|
<span class="comment">// scoped to restrict the lifetime of the borrows
|
|||
|
|
</span><span class="kw">unsafe </span>{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_at_mut_unchecked(<span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(left, [<span class="number">1</span>, <span class="number">0</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, [<span class="number">3</span>, <span class="number">0</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
left[<span class="number">1</span>] = <span class="number">2</span>;
|
|||
|
|
right[<span class="number">1</span>] = <span class="number">4</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_array_ref" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2061">source</a><h4 class="code-header">pub fn <a href="#method.split_array_ref" class="fn">split_array_ref</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> (&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>split_array</code>)</span></div></span></summary><div class="docblock"><p>Divides one slice into an array and a remainder slice at an index.</p>
|
|||
|
|
<p>The array will contain all indices from <code>[0, N)</code> (excluding
|
|||
|
|
the index <code>N</code> itself) and the slice will contain all
|
|||
|
|
indices from <code>[N, len)</code> (excluding the index <code>len</code> itself).</p>
|
|||
|
|
<h5 id="panics-20"><a href="#panics-20">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N > len</code>.</p>
|
|||
|
|
<h5 id="examples-58"><a href="#examples-58">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(split_array)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>v = <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>][..];
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_array_ref::<<span class="number">0</span>>();
|
|||
|
|
<span class="macro">assert_eq!</span>(left, <span class="kw-2">&</span>[]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_array_ref::<<span class="number">2</span>>();
|
|||
|
|
<span class="macro">assert_eq!</span>(left, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, [<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_array_ref::<<span class="number">6</span>>();
|
|||
|
|
<span class="macro">assert_eq!</span>(left, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, []);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_array_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2094">source</a><h4 class="code-header">pub fn <a href="#method.split_array_mut" class="fn">split_array_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&mut self) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>split_array</code>)</span></div></span></summary><div class="docblock"><p>Divides one mutable slice into an array and a remainder slice at an index.</p>
|
|||
|
|
<p>The array will contain all indices from <code>[0, N)</code> (excluding
|
|||
|
|
the index <code>N</code> itself) and the slice will contain all
|
|||
|
|
indices from <code>[N, len)</code> (excluding the index <code>len</code> itself).</p>
|
|||
|
|
<h5 id="panics-21"><a href="#panics-21">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N > len</code>.</p>
|
|||
|
|
<h5 id="examples-59"><a href="#examples-59">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(split_array)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>v = <span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">0</span>, <span class="number">5</span>, <span class="number">6</span>][..];
|
|||
|
|
<span class="kw">let </span>(left, right) = v.split_array_mut::<<span class="number">2</span>>();
|
|||
|
|
<span class="macro">assert_eq!</span>(left, <span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">0</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, [<span class="number">3</span>, <span class="number">0</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
left[<span class="number">1</span>] = <span class="number">2</span>;
|
|||
|
|
right[<span class="number">1</span>] = <span class="number">4</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(v, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rsplit_array_ref" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2139">source</a><h4 class="code-header">pub fn <a href="#method.rsplit_array_ref" class="fn">rsplit_array_ref</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> (&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>split_array</code>)</span></div></span></summary><div class="docblock"><p>Divides one slice into an array and a remainder slice at an index from
|
|||
|
|
the end.</p>
|
|||
|
|
<p>The slice will contain all indices from <code>[0, len - N)</code> (excluding
|
|||
|
|
the index <code>len - N</code> itself) and the array will contain all
|
|||
|
|
indices from <code>[len - N, len)</code> (excluding the index <code>len</code> itself).</p>
|
|||
|
|
<h5 id="panics-22"><a href="#panics-22">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N > len</code>.</p>
|
|||
|
|
<h5 id="examples-60"><a href="#examples-60">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(split_array)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>v = <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>][..];
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.rsplit_array_ref::<<span class="number">0</span>>();
|
|||
|
|
<span class="macro">assert_eq!</span>(left, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, <span class="kw-2">&</span>[]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.rsplit_array_ref::<<span class="number">2</span>>();
|
|||
|
|
<span class="macro">assert_eq!</span>(left, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, <span class="kw-2">&</span>[<span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = v.rsplit_array_ref::<<span class="number">6</span>>();
|
|||
|
|
<span class="macro">assert_eq!</span>(left, []);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rsplit_array_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2173">source</a><h4 class="code-header">pub fn <a href="#method.rsplit_array_mut" class="fn">rsplit_array_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&mut self) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; N]</a>)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>split_array</code>)</span></div></span></summary><div class="docblock"><p>Divides one mutable slice into an array and a remainder slice at an
|
|||
|
|
index from the end.</p>
|
|||
|
|
<p>The slice will contain all indices from <code>[0, len - N)</code> (excluding
|
|||
|
|
the index <code>N</code> itself) and the array will contain all
|
|||
|
|
indices from <code>[len - N, len)</code> (excluding the index <code>len</code> itself).</p>
|
|||
|
|
<h5 id="panics-23"><a href="#panics-23">Panics</a></h5>
|
|||
|
|
<p>Panics if <code>N > len</code>.</p>
|
|||
|
|
<h5 id="examples-61"><a href="#examples-61">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(split_array)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>v = <span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">0</span>, <span class="number">5</span>, <span class="number">6</span>][..];
|
|||
|
|
<span class="kw">let </span>(left, right) = v.rsplit_array_mut::<<span class="number">4</span>>();
|
|||
|
|
<span class="macro">assert_eq!</span>(left, [<span class="number">1</span>, <span class="number">0</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(right, <span class="kw-2">&mut </span>[<span class="number">3</span>, <span class="number">0</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
left[<span class="number">1</span>] = <span class="number">2</span>;
|
|||
|
|
right[<span class="number">1</span>] = <span class="number">4</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(v, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2222-2224">source</a></span><h4 class="code-header">pub fn <a href="#method.split" class="fn">split</a><F>(&self, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.Split.html" title="struct core::slice::iter::Split">Split</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns an iterator over subslices separated by elements that match
|
|||
|
|
<code>pred</code>. The matched element is not contained in the subslices.</p>
|
|||
|
|
<h5 id="examples-62"><a href="#examples-62">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">33</span>, <span class="number">20</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.split(|num| num % <span class="number">3 </span>== <span class="number">0</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">20</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());</code></pre></div>
|
|||
|
|
<p>If the first element is matched, an empty slice will be the first item
|
|||
|
|
returned by the iterator. Similarly, if the last element in the slice
|
|||
|
|
is matched, an empty slice will be the last item returned by the
|
|||
|
|
iterator:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">33</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.split(|num| num % <span class="number">3 </span>== <span class="number">0</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());</code></pre></div>
|
|||
|
|
<p>If two matched elements are directly adjacent, an empty slice will be
|
|||
|
|
present between them:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="number">10</span>, <span class="number">6</span>, <span class="number">33</span>, <span class="number">20</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.split(|num| num % <span class="number">3 </span>== <span class="number">0</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">10</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">20</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2244-2246">source</a></span><h4 class="code-header">pub fn <a href="#method.split_mut" class="fn">split_mut</a><F>(&mut self, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.SplitMut.html" title="struct core::slice::iter::SplitMut">SplitMut</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns an iterator over mutable subslices separated by elements that
|
|||
|
|
match <code>pred</code>. The matched element is not contained in the subslices.</p>
|
|||
|
|
<h5 id="examples-63"><a href="#examples-63">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>, <span class="number">20</span>, <span class="number">60</span>, <span class="number">50</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>group <span class="kw">in </span>v.split_mut(|num| <span class="kw-2">*</span>num % <span class="number">3 </span>== <span class="number">0</span>) {
|
|||
|
|
group[<span class="number">0</span>] = <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, [<span class="number">1</span>, <span class="number">40</span>, <span class="number">30</span>, <span class="number">1</span>, <span class="number">60</span>, <span class="number">1</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_inclusive" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.51.0">1.51.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2280-2282">source</a></span><h4 class="code-header">pub fn <a href="#method.split_inclusive" class="fn">split_inclusive</a><F>(&self, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.SplitInclusive.html" title="struct core::slice::iter::SplitInclusive">SplitInclusive</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns an iterator over subslices separated by elements that match
|
|||
|
|
<code>pred</code>. The matched element is contained in the end of the previous
|
|||
|
|
subslice as a terminator.</p>
|
|||
|
|
<h5 id="examples-64"><a href="#examples-64">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">33</span>, <span class="number">20</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.split_inclusive(|num| num % <span class="number">3 </span>== <span class="number">0</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>, <span class="number">33</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">20</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());</code></pre></div>
|
|||
|
|
<p>If the last element of the slice is matched,
|
|||
|
|
that element will be considered the terminator of the preceding slice.
|
|||
|
|
That slice will be the last item returned by the iterator.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="number">3</span>, <span class="number">10</span>, <span class="number">40</span>, <span class="number">33</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.split_inclusive(|num| num % <span class="number">3 </span>== <span class="number">0</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">3</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>, <span class="number">33</span>]);
|
|||
|
|
<span class="macro">assert!</span>(iter.next().is_none());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_inclusive_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.51.0">1.51.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2304-2306">source</a></span><h4 class="code-header">pub fn <a href="#method.split_inclusive_mut" class="fn">split_inclusive_mut</a><F>(&mut self, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.SplitInclusiveMut.html" title="struct core::slice::iter::SplitInclusiveMut">SplitInclusiveMut</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns an iterator over mutable subslices separated by elements that
|
|||
|
|
match <code>pred</code>. The matched element is contained in the previous
|
|||
|
|
subslice as a terminator.</p>
|
|||
|
|
<h5 id="examples-65"><a href="#examples-65">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>, <span class="number">20</span>, <span class="number">60</span>, <span class="number">50</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>group <span class="kw">in </span>v.split_inclusive_mut(|num| <span class="kw-2">*</span>num % <span class="number">3 </span>== <span class="number">0</span>) {
|
|||
|
|
<span class="kw">let </span>terminator_idx = group.len()-<span class="number">1</span>;
|
|||
|
|
group[terminator_idx] = <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, [<span class="number">10</span>, <span class="number">40</span>, <span class="number">1</span>, <span class="number">20</span>, <span class="number">1</span>, <span class="number">1</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rsplit" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.27.0">1.27.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2340-2342">source</a></span><h4 class="code-header">pub fn <a href="#method.rsplit" class="fn">rsplit</a><F>(&self, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.RSplit.html" title="struct core::slice::iter::RSplit">RSplit</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns an iterator over subslices separated by elements that match
|
|||
|
|
<code>pred</code>, starting at the end of the slice and working backwards.
|
|||
|
|
The matched element is not contained in the subslices.</p>
|
|||
|
|
<h5 id="examples-66"><a href="#examples-66">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>slice = [<span class="number">11</span>, <span class="number">22</span>, <span class="number">33</span>, <span class="number">0</span>, <span class="number">44</span>, <span class="number">55</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = slice.rsplit(|num| <span class="kw-2">*</span>num == <span class="number">0</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">44</span>, <span class="number">55</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next().unwrap(), <span class="kw-2">&</span>[<span class="number">11</span>, <span class="number">22</span>, <span class="number">33</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">None</span>);</code></pre></div>
|
|||
|
|
<p>As with <code>split()</code>, if the first or last element is matched, an empty
|
|||
|
|
slice will be the first (or last) item returned by the iterator.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = <span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">8</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>it = v.rsplit(|n| <span class="kw-2">*</span>n % <span class="number">2 </span>== <span class="number">0</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(it.next().unwrap(), <span class="kw-2">&</span>[]);
|
|||
|
|
<span class="macro">assert_eq!</span>(it.next().unwrap(), <span class="kw-2">&</span>[<span class="number">3</span>, <span class="number">5</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(it.next().unwrap(), <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">1</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(it.next().unwrap(), <span class="kw-2">&</span>[]);
|
|||
|
|
<span class="macro">assert_eq!</span>(it.next(), <span class="prelude-val">None</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rsplit_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.27.0">1.27.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2366-2368">source</a></span><h4 class="code-header">pub fn <a href="#method.rsplit_mut" class="fn">rsplit_mut</a><F>(&mut self, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.RSplitMut.html" title="struct core::slice::iter::RSplitMut">RSplitMut</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns an iterator over mutable subslices separated by elements that
|
|||
|
|
match <code>pred</code>, starting at the end of the slice and working
|
|||
|
|
backwards. The matched element is not contained in the subslices.</p>
|
|||
|
|
<h5 id="examples-67"><a href="#examples-67">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">100</span>, <span class="number">400</span>, <span class="number">300</span>, <span class="number">200</span>, <span class="number">600</span>, <span class="number">500</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">0</span>;
|
|||
|
|
<span class="kw">for </span>group <span class="kw">in </span>v.rsplit_mut(|num| <span class="kw-2">*</span>num % <span class="number">3 </span>== <span class="number">0</span>) {
|
|||
|
|
count += <span class="number">1</span>;
|
|||
|
|
group[<span class="number">0</span>] = count;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, [<span class="number">3</span>, <span class="number">400</span>, <span class="number">300</span>, <span class="number">2</span>, <span class="number">600</span>, <span class="number">1</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.splitn" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2394-2396">source</a></span><h4 class="code-header">pub fn <a href="#method.splitn" class="fn">splitn</a><F>(&self, n: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.SplitN.html" title="struct core::slice::iter::SplitN">SplitN</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns an iterator over subslices separated by elements that match
|
|||
|
|
<code>pred</code>, limited to returning at most <code>n</code> items. The matched element is
|
|||
|
|
not contained in the subslices.</p>
|
|||
|
|
<p>The last element returned, if any, will contain the remainder of the
|
|||
|
|
slice.</p>
|
|||
|
|
<h5 id="examples-68"><a href="#examples-68">Examples</a></h5>
|
|||
|
|
<p>Print the slice split once by numbers divisible by 3 (i.e., <code>[10, 40]</code>,
|
|||
|
|
<code>[20, 60, 50]</code>):</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>, <span class="number">20</span>, <span class="number">60</span>, <span class="number">50</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>group <span class="kw">in </span>v.splitn(<span class="number">2</span>, |num| <span class="kw-2">*</span>num % <span class="number">3 </span>== <span class="number">0</span>) {
|
|||
|
|
<span class="macro">println!</span>(<span class="string">"{group:?}"</span>);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.splitn_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2420-2422">source</a></span><h4 class="code-header">pub fn <a href="#method.splitn_mut" class="fn">splitn_mut</a><F>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.SplitNMut.html" title="struct core::slice::iter::SplitNMut">SplitNMut</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns an iterator over mutable subslices separated by elements that match
|
|||
|
|
<code>pred</code>, limited to returning at most <code>n</code> items. The matched element is
|
|||
|
|
not contained in the subslices.</p>
|
|||
|
|
<p>The last element returned, if any, will contain the remainder of the
|
|||
|
|
slice.</p>
|
|||
|
|
<h5 id="examples-69"><a href="#examples-69">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>, <span class="number">20</span>, <span class="number">60</span>, <span class="number">50</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>group <span class="kw">in </span>v.splitn_mut(<span class="number">2</span>, |num| <span class="kw-2">*</span>num % <span class="number">3 </span>== <span class="number">0</span>) {
|
|||
|
|
group[<span class="number">0</span>] = <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, [<span class="number">1</span>, <span class="number">40</span>, <span class="number">30</span>, <span class="number">1</span>, <span class="number">60</span>, <span class="number">50</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rsplitn" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2449-2451">source</a></span><h4 class="code-header">pub fn <a href="#method.rsplitn" class="fn">rsplitn</a><F>(&self, n: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.RSplitN.html" title="struct core::slice::iter::RSplitN">RSplitN</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns an iterator over subslices separated by elements that match
|
|||
|
|
<code>pred</code> limited to returning at most <code>n</code> items. This starts at the end of
|
|||
|
|
the slice and works backwards. The matched element is not contained in
|
|||
|
|
the subslices.</p>
|
|||
|
|
<p>The last element returned, if any, will contain the remainder of the
|
|||
|
|
slice.</p>
|
|||
|
|
<h5 id="examples-70"><a href="#examples-70">Examples</a></h5>
|
|||
|
|
<p>Print the slice split once, starting from the end, by numbers divisible
|
|||
|
|
by 3 (i.e., <code>[50]</code>, <code>[10, 40, 30, 20]</code>):</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>, <span class="number">20</span>, <span class="number">60</span>, <span class="number">50</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>group <span class="kw">in </span>v.rsplitn(<span class="number">2</span>, |num| <span class="kw-2">*</span>num % <span class="number">3 </span>== <span class="number">0</span>) {
|
|||
|
|
<span class="macro">println!</span>(<span class="string">"{group:?}"</span>);
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rsplitn_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2476-2478">source</a></span><h4 class="code-header">pub fn <a href="#method.rsplitn_mut" class="fn">rsplitn_mut</a><F>(&mut self, n: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, pred: F) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/iter/struct.RSplitNMut.html" title="struct core::slice::iter::RSplitNMut">RSplitNMut</a><'_, T, F><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns an iterator over subslices separated by elements that match
|
|||
|
|
<code>pred</code> limited to returning at most <code>n</code> items. This starts at the end of
|
|||
|
|
the slice and works backwards. The matched element is not contained in
|
|||
|
|
the subslices.</p>
|
|||
|
|
<p>The last element returned, if any, will contain the remainder of the
|
|||
|
|
slice.</p>
|
|||
|
|
<h5 id="examples-71"><a href="#examples-71">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>s = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>, <span class="number">20</span>, <span class="number">60</span>, <span class="number">50</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">for </span>group <span class="kw">in </span>s.rsplitn_mut(<span class="number">2</span>, |num| <span class="kw-2">*</span>num % <span class="number">3 </span>== <span class="number">0</span>) {
|
|||
|
|
group[<span class="number">0</span>] = <span class="number">1</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(s, [<span class="number">1</span>, <span class="number">40</span>, <span class="number">30</span>, <span class="number">20</span>, <span class="number">60</span>, <span class="number">1</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.split_once" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2503-2505">source</a><h4 class="code-header">pub fn <a href="#method.split_once" class="fn">split_once</a><F>(&self, pred: F) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_split_once</code>)</span></div></span></summary><div class="docblock"><p>Splits the slice on the first element that matches the specified
|
|||
|
|
predicate.</p>
|
|||
|
|
<p>If any matching elements are resent in the slice, returns the prefix
|
|||
|
|
before the match and suffix after. The matching element itself is not
|
|||
|
|
included. If no elements match, returns <code>None</code>.</p>
|
|||
|
|
<h5 id="examples-72"><a href="#examples-72">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_split_once)]
|
|||
|
|
</span><span class="kw">let </span>s = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">4</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(s.split_once(|<span class="kw-2">&</span>x| x == <span class="number">2</span>), <span class="prelude-val">Some</span>((
|
|||
|
|
<span class="kw-2">&</span>[<span class="number">1</span>][..],
|
|||
|
|
<span class="kw-2">&</span>[<span class="number">3</span>, <span class="number">2</span>, <span class="number">4</span>][..]
|
|||
|
|
)));
|
|||
|
|
<span class="macro">assert_eq!</span>(s.split_once(|<span class="kw-2">&</span>x| x == <span class="number">0</span>), <span class="prelude-val">None</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rsplit_once" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2531-2533">source</a><h4 class="code-header">pub fn <a href="#method.rsplit_once" class="fn">rsplit_once</a><F>(&self, pred: F) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_split_once</code>)</span></div></span></summary><div class="docblock"><p>Splits the slice on the last element that matches the specified
|
|||
|
|
predicate.</p>
|
|||
|
|
<p>If any matching elements are resent in the slice, returns the prefix
|
|||
|
|
before the match and suffix after. The matching element itself is not
|
|||
|
|
included. If no elements match, returns <code>None</code>.</p>
|
|||
|
|
<h5 id="examples-73"><a href="#examples-73">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_split_once)]
|
|||
|
|
</span><span class="kw">let </span>s = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">4</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(s.rsplit_once(|<span class="kw-2">&</span>x| x == <span class="number">2</span>), <span class="prelude-val">Some</span>((
|
|||
|
|
<span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>][..],
|
|||
|
|
<span class="kw-2">&</span>[<span class="number">4</span>][..]
|
|||
|
|
)));
|
|||
|
|
<span class="macro">assert_eq!</span>(s.rsplit_once(|<span class="kw-2">&</span>x| x == <span class="number">0</span>), <span class="prelude-val">None</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.contains" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2567-2569">source</a></span><h4 class="code-header">pub fn <a href="#method.contains" class="fn">contains</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a><div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the slice contains an element with the given value.</p>
|
|||
|
|
<p>This operation is <em>O</em>(<em>n</em>).</p>
|
|||
|
|
<p>Note that if you have a sorted slice, <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.binary_search" title="method slice::binary_search"><code>binary_search</code></a> may be faster.</p>
|
|||
|
|
<h5 id="examples-74"><a href="#examples-74">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert!</span>(v.contains(<span class="kw-2">&</span><span class="number">30</span>));
|
|||
|
|
<span class="macro">assert!</span>(!v.contains(<span class="kw-2">&</span><span class="number">50</span>));</code></pre></div>
|
|||
|
|
<p>If you do not have a <code>&T</code>, but some other value that you can compare
|
|||
|
|
with one (for example, <code>String</code> implements <code>PartialEq<str></code>), you can
|
|||
|
|
use <code>iter().any</code>:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [String::from(<span class="string">"hello"</span>), String::from(<span class="string">"world"</span>)]; <span class="comment">// slice of `String`
|
|||
|
|
</span><span class="macro">assert!</span>(v.iter().any(|e| e == <span class="string">"hello"</span>)); <span class="comment">// search with `&str`
|
|||
|
|
</span><span class="macro">assert!</span>(!v.iter().any(|e| e == <span class="string">"hi"</span>));</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.starts_with" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2596-2598">source</a></span><h4 class="code-header">pub fn <a href="#method.starts_with" class="fn">starts_with</a>(&self, needle: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a><div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if <code>needle</code> is a prefix of the slice.</p>
|
|||
|
|
<h5 id="examples-75"><a href="#examples-75">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert!</span>(v.starts_with(<span class="kw-2">&</span>[<span class="number">10</span>]));
|
|||
|
|
<span class="macro">assert!</span>(v.starts_with(<span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>]));
|
|||
|
|
<span class="macro">assert!</span>(!v.starts_with(<span class="kw-2">&</span>[<span class="number">50</span>]));
|
|||
|
|
<span class="macro">assert!</span>(!v.starts_with(<span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">50</span>]));</code></pre></div>
|
|||
|
|
<p>Always returns <code>true</code> if <code>needle</code> is an empty slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = <span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert!</span>(v.starts_with(<span class="kw-2">&</span>[]));
|
|||
|
|
<span class="kw">let </span>v: <span class="kw-2">&</span>[u8] = <span class="kw-2">&</span>[];
|
|||
|
|
<span class="macro">assert!</span>(v.starts_with(<span class="kw-2">&</span>[]));</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.ends_with" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2626-2628">source</a></span><h4 class="code-header">pub fn <a href="#method.ends_with" class="fn">ends_with</a>(&self, needle: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a><div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if <code>needle</code> is a suffix of the slice.</p>
|
|||
|
|
<h5 id="examples-76"><a href="#examples-76">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert!</span>(v.ends_with(<span class="kw-2">&</span>[<span class="number">30</span>]));
|
|||
|
|
<span class="macro">assert!</span>(v.ends_with(<span class="kw-2">&</span>[<span class="number">40</span>, <span class="number">30</span>]));
|
|||
|
|
<span class="macro">assert!</span>(!v.ends_with(<span class="kw-2">&</span>[<span class="number">50</span>]));
|
|||
|
|
<span class="macro">assert!</span>(!v.ends_with(<span class="kw-2">&</span>[<span class="number">50</span>, <span class="number">30</span>]));</code></pre></div>
|
|||
|
|
<p>Always returns <code>true</code> if <code>needle</code> is an empty slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = <span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert!</span>(v.ends_with(<span class="kw-2">&</span>[]));
|
|||
|
|
<span class="kw">let </span>v: <span class="kw-2">&</span>[u8] = <span class="kw-2">&</span>[];
|
|||
|
|
<span class="macro">assert!</span>(v.ends_with(<span class="kw-2">&</span>[]));</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.strip_prefix" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.51.0">1.51.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2656-2658">source</a></span><h4 class="code-header">pub fn <a href="#method.strip_prefix" class="fn">strip_prefix</a><P>(&self, prefix: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&P</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>><div class="where">where
|
|||
|
|
P: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/trait.SlicePattern.html" title="trait core::slice::SlicePattern">SlicePattern</a><Item = T> + ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></h4></section></summary><div class="docblock"><p>Returns a subslice with the prefix removed.</p>
|
|||
|
|
<p>If the slice starts with <code>prefix</code>, returns the subslice after the prefix, wrapped in <code>Some</code>.
|
|||
|
|
If <code>prefix</code> is empty, simply returns the original slice.</p>
|
|||
|
|
<p>If the slice does not start with <code>prefix</code>, returns <code>None</code>.</p>
|
|||
|
|
<h5 id="examples-77"><a href="#examples-77">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = <span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(v.strip_prefix(<span class="kw-2">&</span>[<span class="number">10</span>]), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">40</span>, <span class="number">30</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(v.strip_prefix(<span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>]), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">30</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(v.strip_prefix(<span class="kw-2">&</span>[<span class="number">50</span>]), <span class="prelude-val">None</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(v.strip_prefix(<span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">50</span>]), <span class="prelude-val">None</span>);
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>prefix : <span class="kw-2">&</span>str = <span class="string">"he"</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="string">b"hello"</span>.strip_prefix(prefix.as_bytes()),
|
|||
|
|
<span class="prelude-val">Some</span>(<span class="string">b"llo"</span>.as_ref()));</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.strip_suffix" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.51.0">1.51.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2690-2692">source</a></span><h4 class="code-header">pub fn <a href="#method.strip_suffix" class="fn">strip_suffix</a><P>(&self, suffix: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&P</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>><div class="where">where
|
|||
|
|
P: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/trait.SlicePattern.html" title="trait core::slice::SlicePattern">SlicePattern</a><Item = T> + ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></h4></section></summary><div class="docblock"><p>Returns a subslice with the suffix removed.</p>
|
|||
|
|
<p>If the slice ends with <code>suffix</code>, returns the subslice before the suffix, wrapped in <code>Some</code>.
|
|||
|
|
If <code>suffix</code> is empty, simply returns the original slice.</p>
|
|||
|
|
<p>If the slice does not end with <code>suffix</code>, returns <code>None</code>.</p>
|
|||
|
|
<h5 id="examples-78"><a href="#examples-78">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = <span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(v.strip_suffix(<span class="kw-2">&</span>[<span class="number">30</span>]), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">40</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(v.strip_suffix(<span class="kw-2">&</span>[<span class="number">40</span>, <span class="number">30</span>]), <span class="prelude-val">Some</span>(<span class="kw-2">&</span>[<span class="number">10</span>][..]));
|
|||
|
|
<span class="macro">assert_eq!</span>(v.strip_suffix(<span class="kw-2">&</span>[<span class="number">50</span>]), <span class="prelude-val">None</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(v.strip_suffix(<span class="kw-2">&</span>[<span class="number">50</span>, <span class="number">30</span>]), <span class="prelude-val">None</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.binary_search" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2774-2776">source</a></span><h4 class="code-header">pub fn <a href="#method.binary_search" class="fn">binary_search</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>><div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Binary searches this slice for a given element.
|
|||
|
|
If the slice is not sorted, the returned result is unspecified and
|
|||
|
|
meaningless.</p>
|
|||
|
|
<p>If the value is found then <a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html#variant.Ok" title="variant core::result::Result::Ok"><code>Result::Ok</code></a> is returned, containing the
|
|||
|
|
index of the matching element. If there are multiple matches, then any
|
|||
|
|
one of the matches could be returned. The index is chosen
|
|||
|
|
deterministically, but is subject to change in future versions of Rust.
|
|||
|
|
If the value is not found then <a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html#variant.Err" title="variant core::result::Result::Err"><code>Result::Err</code></a> is returned, containing
|
|||
|
|
the index where a matching element could be inserted while maintaining
|
|||
|
|
sorted order.</p>
|
|||
|
|
<p>See also <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.binary_search_by" title="method slice::binary_search_by"><code>binary_search_by</code></a>, <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.binary_search_by_key" title="method slice::binary_search_by_key"><code>binary_search_by_key</code></a>, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.partition_point" title="method slice::partition_point"><code>partition_point</code></a>.</p>
|
|||
|
|
<h5 id="examples-79"><a href="#examples-79">Examples</a></h5>
|
|||
|
|
<p>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 <code>[1, 4]</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = [<span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">8</span>, <span class="number">13</span>, <span class="number">21</span>, <span class="number">34</span>, <span class="number">55</span>];
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(s.binary_search(<span class="kw-2">&</span><span class="number">13</span>), <span class="prelude-val">Ok</span>(<span class="number">9</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(s.binary_search(<span class="kw-2">&</span><span class="number">4</span>), <span class="prelude-val">Err</span>(<span class="number">7</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(s.binary_search(<span class="kw-2">&</span><span class="number">100</span>), <span class="prelude-val">Err</span>(<span class="number">13</span>));
|
|||
|
|
<span class="kw">let </span>r = s.binary_search(<span class="kw-2">&</span><span class="number">1</span>);
|
|||
|
|
<span class="macro">assert!</span>(<span class="kw">match </span>r { <span class="prelude-val">Ok</span>(<span class="number">1</span>..=<span class="number">4</span>) => <span class="bool-val">true</span>, <span class="kw">_ </span>=> <span class="bool-val">false</span>, });</code></pre></div>
|
|||
|
|
<p>If you want to find that whole <em>range</em> of matching items, rather than
|
|||
|
|
an arbitrary matching one, that can be done using <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.partition_point" title="method slice::partition_point"><code>partition_point</code></a>:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = [<span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">8</span>, <span class="number">13</span>, <span class="number">21</span>, <span class="number">34</span>, <span class="number">55</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>low = s.partition_point(|x| x < <span class="kw-2">&</span><span class="number">1</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(low, <span class="number">1</span>);
|
|||
|
|
<span class="kw">let </span>high = s.partition_point(|x| x <= <span class="kw-2">&</span><span class="number">1</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(high, <span class="number">5</span>);
|
|||
|
|
<span class="kw">let </span>r = s.binary_search(<span class="kw-2">&</span><span class="number">1</span>);
|
|||
|
|
<span class="macro">assert!</span>((low..high).contains(<span class="kw-2">&</span>r.unwrap()));
|
|||
|
|
|
|||
|
|
<span class="macro">assert!</span>(s[..low].iter().all(|<span class="kw-2">&</span>x| x < <span class="number">1</span>));
|
|||
|
|
<span class="macro">assert!</span>(s[low..high].iter().all(|<span class="kw-2">&</span>x| x == <span class="number">1</span>));
|
|||
|
|
<span class="macro">assert!</span>(s[high..].iter().all(|<span class="kw-2">&</span>x| x > <span class="number">1</span>));
|
|||
|
|
|
|||
|
|
<span class="comment">// For something not found, the "range" of equal items is empty
|
|||
|
|
</span><span class="macro">assert_eq!</span>(s.partition_point(|x| x < <span class="kw-2">&</span><span class="number">11</span>), <span class="number">9</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(s.partition_point(|x| x <= <span class="kw-2">&</span><span class="number">11</span>), <span class="number">9</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(s.binary_search(<span class="kw-2">&</span><span class="number">11</span>), <span class="prelude-val">Err</span>(<span class="number">9</span>));</code></pre></div>
|
|||
|
|
<p>If you want to insert an item to a sorted vector, while maintaining
|
|||
|
|
sort order, consider using <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.partition_point" title="method slice::partition_point"><code>partition_point</code></a>:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>s = <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">8</span>, <span class="number">13</span>, <span class="number">21</span>, <span class="number">34</span>, <span class="number">55</span>];
|
|||
|
|
<span class="kw">let </span>num = <span class="number">42</span>;
|
|||
|
|
<span class="kw">let </span>idx = s.partition_point(|<span class="kw-2">&</span>x| x < num);
|
|||
|
|
<span class="comment">// The above is equivalent to `let idx = s.binary_search(&num).unwrap_or_else(|x| x);`
|
|||
|
|
</span>s.insert(idx, num);
|
|||
|
|
<span class="macro">assert_eq!</span>(s, [<span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">8</span>, <span class="number">13</span>, <span class="number">21</span>, <span class="number">34</span>, <span class="number">42</span>, <span class="number">55</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.binary_search_by" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2825-2827">source</a></span><h4 class="code-header">pub fn <a href="#method.binary_search_by" class="fn">binary_search_by</a><'a, F>(&'a self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'a T</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>,</div></h4></section></summary><div class="docblock"><p>Binary searches this slice with a comparator function.</p>
|
|||
|
|
<p>The comparator function should return an order code that indicates
|
|||
|
|
whether its argument is <code>Less</code>, <code>Equal</code> or <code>Greater</code> the desired
|
|||
|
|
target.
|
|||
|
|
If the slice is not sorted or if the comparator function does not
|
|||
|
|
implement an order consistent with the sort order of the underlying
|
|||
|
|
slice, the returned result is unspecified and meaningless.</p>
|
|||
|
|
<p>If the value is found then <a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html#variant.Ok" title="variant core::result::Result::Ok"><code>Result::Ok</code></a> is returned, containing the
|
|||
|
|
index of the matching element. If there are multiple matches, then any
|
|||
|
|
one of the matches could be returned. The index is chosen
|
|||
|
|
deterministically, but is subject to change in future versions of Rust.
|
|||
|
|
If the value is not found then <a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html#variant.Err" title="variant core::result::Result::Err"><code>Result::Err</code></a> is returned, containing
|
|||
|
|
the index where a matching element could be inserted while maintaining
|
|||
|
|
sorted order.</p>
|
|||
|
|
<p>See also <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.binary_search" title="method slice::binary_search"><code>binary_search</code></a>, <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.binary_search_by_key" title="method slice::binary_search_by_key"><code>binary_search_by_key</code></a>, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.partition_point" title="method slice::partition_point"><code>partition_point</code></a>.</p>
|
|||
|
|
<h5 id="examples-80"><a href="#examples-80">Examples</a></h5>
|
|||
|
|
<p>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 <code>[1, 4]</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = [<span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">8</span>, <span class="number">13</span>, <span class="number">21</span>, <span class="number">34</span>, <span class="number">55</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>seek = <span class="number">13</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(s.binary_search_by(|probe| probe.cmp(<span class="kw-2">&</span>seek)), <span class="prelude-val">Ok</span>(<span class="number">9</span>));
|
|||
|
|
<span class="kw">let </span>seek = <span class="number">4</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(s.binary_search_by(|probe| probe.cmp(<span class="kw-2">&</span>seek)), <span class="prelude-val">Err</span>(<span class="number">7</span>));
|
|||
|
|
<span class="kw">let </span>seek = <span class="number">100</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(s.binary_search_by(|probe| probe.cmp(<span class="kw-2">&</span>seek)), <span class="prelude-val">Err</span>(<span class="number">13</span>));
|
|||
|
|
<span class="kw">let </span>seek = <span class="number">1</span>;
|
|||
|
|
<span class="kw">let </span>r = s.binary_search_by(|probe| probe.cmp(<span class="kw-2">&</span>seek));
|
|||
|
|
<span class="macro">assert!</span>(<span class="kw">match </span>r { <span class="prelude-val">Ok</span>(<span class="number">1</span>..=<span class="number">4</span>) => <span class="bool-val">true</span>, <span class="kw">_ </span>=> <span class="bool-val">false</span>, });</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.binary_search_by_key" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.10.0">1.10.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2913-2916">source</a></span><h4 class="code-header">pub fn <a href="#method.binary_search_by_key" class="fn">binary_search_by_key</a><'a, B, F>(
|
|||
|
|
&'a self,
|
|||
|
|
b: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&B</a>,
|
|||
|
|
f: F
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'a T</a>) -> B,
|
|||
|
|
B: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Binary searches this slice with a key extraction function.</p>
|
|||
|
|
<p>Assumes that the slice is sorted by the key, for instance with
|
|||
|
|
<a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_by_key" title="method slice::sort_by_key"><code>sort_by_key</code></a> using the same key extraction function.
|
|||
|
|
If the slice is not sorted by the key, the returned result is
|
|||
|
|
unspecified and meaningless.</p>
|
|||
|
|
<p>If the value is found then <a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html#variant.Ok" title="variant core::result::Result::Ok"><code>Result::Ok</code></a> is returned, containing the
|
|||
|
|
index of the matching element. If there are multiple matches, then any
|
|||
|
|
one of the matches could be returned. The index is chosen
|
|||
|
|
deterministically, but is subject to change in future versions of Rust.
|
|||
|
|
If the value is not found then <a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html#variant.Err" title="variant core::result::Result::Err"><code>Result::Err</code></a> is returned, containing
|
|||
|
|
the index where a matching element could be inserted while maintaining
|
|||
|
|
sorted order.</p>
|
|||
|
|
<p>See also <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.binary_search" title="method slice::binary_search"><code>binary_search</code></a>, <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.binary_search_by" title="method slice::binary_search_by"><code>binary_search_by</code></a>, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.partition_point" title="method slice::partition_point"><code>partition_point</code></a>.</p>
|
|||
|
|
<h5 id="examples-81"><a href="#examples-81">Examples</a></h5>
|
|||
|
|
<p>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 <code>[1, 4]</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = [(<span class="number">0</span>, <span class="number">0</span>), (<span class="number">2</span>, <span class="number">1</span>), (<span class="number">4</span>, <span class="number">1</span>), (<span class="number">5</span>, <span class="number">1</span>), (<span class="number">3</span>, <span class="number">1</span>),
|
|||
|
|
(<span class="number">1</span>, <span class="number">2</span>), (<span class="number">2</span>, <span class="number">3</span>), (<span class="number">4</span>, <span class="number">5</span>), (<span class="number">5</span>, <span class="number">8</span>), (<span class="number">3</span>, <span class="number">13</span>),
|
|||
|
|
(<span class="number">1</span>, <span class="number">21</span>), (<span class="number">2</span>, <span class="number">34</span>), (<span class="number">4</span>, <span class="number">55</span>)];
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(s.binary_search_by_key(<span class="kw-2">&</span><span class="number">13</span>, |<span class="kw-2">&</span>(a, b)| b), <span class="prelude-val">Ok</span>(<span class="number">9</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(s.binary_search_by_key(<span class="kw-2">&</span><span class="number">4</span>, |<span class="kw-2">&</span>(a, b)| b), <span class="prelude-val">Err</span>(<span class="number">7</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(s.binary_search_by_key(<span class="kw-2">&</span><span class="number">100</span>, |<span class="kw-2">&</span>(a, b)| b), <span class="prelude-val">Err</span>(<span class="number">13</span>));
|
|||
|
|
<span class="kw">let </span>r = s.binary_search_by_key(<span class="kw-2">&</span><span class="number">1</span>, |<span class="kw-2">&</span>(a, b)| b);
|
|||
|
|
<span class="macro">assert!</span>(<span class="kw">match </span>r { <span class="prelude-val">Ok</span>(<span class="number">1</span>..=<span class="number">4</span>) => <span class="bool-val">true</span>, <span class="kw">_ </span>=> <span class="bool-val">false</span>, });</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.sort_unstable" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.20.0">1.20.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#2949-2951">source</a></span><h4 class="code-header">pub fn <a href="#method.sort_unstable" class="fn">sort_unstable</a>(&mut self)<div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Sorts the slice, but might not preserve the order of equal elements.</p>
|
|||
|
|
<p>This sort is unstable (i.e., may reorder equal elements), in-place
|
|||
|
|
(i.e., does not allocate), and <em>O</em>(<em>n</em> * log(<em>n</em>)) worst-case.</p>
|
|||
|
|
<h5 id="current-implementation"><a href="#current-implementation">Current implementation</a></h5>
|
|||
|
|
<p>The current algorithm is based on <a href="https://github.com/orlp/pdqsort">pattern-defeating quicksort</a> by Orson Peters,
|
|||
|
|
which combines the fast average case of randomized quicksort with the fast worst case of
|
|||
|
|
heapsort, while achieving linear time on slices with certain patterns. It uses some
|
|||
|
|
randomization to avoid degenerate cases, but with a fixed seed to always provide
|
|||
|
|
deterministic behavior.</p>
|
|||
|
|
<p>It is typically faster than stable sorting, except in a few special cases, e.g., when the
|
|||
|
|
slice consists of several concatenated sorted sequences.</p>
|
|||
|
|
<h5 id="examples-82"><a href="#examples-82">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [-<span class="number">5</span>, <span class="number">4</span>, <span class="number">1</span>, -<span class="number">3</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
v.sort_unstable();
|
|||
|
|
<span class="macro">assert!</span>(v == [-<span class="number">5</span>, -<span class="number">3</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.sort_unstable_by" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.20.0">1.20.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3004-3006">source</a></span><h4 class="code-header">pub fn <a href="#method.sort_unstable_by" class="fn">sort_unstable_by</a><F>(&mut self, compare: F)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>,</div></h4></section></summary><div class="docblock"><p>Sorts the slice with a comparator function, but might not preserve the order of equal
|
|||
|
|
elements.</p>
|
|||
|
|
<p>This sort is unstable (i.e., may reorder equal elements), in-place
|
|||
|
|
(i.e., does not allocate), and <em>O</em>(<em>n</em> * log(<em>n</em>)) worst-case.</p>
|
|||
|
|
<p>The comparator function must define a total ordering for the elements in the slice. If
|
|||
|
|
the ordering is not total, the order of the elements is unspecified. An order is a
|
|||
|
|
total order if it is (for all <code>a</code>, <code>b</code> and <code>c</code>):</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>total and antisymmetric: exactly one of <code>a < b</code>, <code>a == b</code> or <code>a > b</code> is true, and</li>
|
|||
|
|
<li>transitive, <code>a < b</code> and <code>b < c</code> implies <code>a < c</code>. The same must hold for both <code>==</code> and <code>></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>For example, while <a href="https://doc.rust-lang.org/1.76.0/core/primitive.f64.html" title="primitive f64"><code>f64</code></a> doesn’t implement <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord"><code>Ord</code></a> because <code>NaN != NaN</code>, we can use
|
|||
|
|
<code>partial_cmp</code> as our sort function when we know the slice doesn’t contain a <code>NaN</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>floats = [<span class="number">5f64</span>, <span class="number">4.0</span>, <span class="number">1.0</span>, <span class="number">3.0</span>, <span class="number">2.0</span>];
|
|||
|
|
floats.sort_unstable_by(|a, b| a.partial_cmp(b).unwrap());
|
|||
|
|
<span class="macro">assert_eq!</span>(floats, [<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>, <span class="number">4.0</span>, <span class="number">5.0</span>]);</code></pre></div>
|
|||
|
|
<h5 id="current-implementation-1"><a href="#current-implementation-1">Current implementation</a></h5>
|
|||
|
|
<p>The current algorithm is based on <a href="https://github.com/orlp/pdqsort">pattern-defeating quicksort</a> by Orson Peters,
|
|||
|
|
which combines the fast average case of randomized quicksort with the fast worst case of
|
|||
|
|
heapsort, while achieving linear time on slices with certain patterns. It uses some
|
|||
|
|
randomization to avoid degenerate cases, but with a fixed seed to always provide
|
|||
|
|
deterministic behavior.</p>
|
|||
|
|
<p>It is typically faster than stable sorting, except in a few special cases, e.g., when the
|
|||
|
|
slice consists of several concatenated sorted sequences.</p>
|
|||
|
|
<h5 id="examples-83"><a href="#examples-83">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">5</span>, <span class="number">4</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">2</span>];
|
|||
|
|
v.sort_unstable_by(|a, b| a.cmp(b));
|
|||
|
|
<span class="macro">assert!</span>(v == [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);
|
|||
|
|
|
|||
|
|
<span class="comment">// reverse sorting
|
|||
|
|
</span>v.sort_unstable_by(|a, b| b.cmp(a));
|
|||
|
|
<span class="macro">assert!</span>(v == [<span class="number">5</span>, <span class="number">4</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">1</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.sort_unstable_by_key" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.20.0">1.20.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3042-3045">source</a></span><h4 class="code-header">pub fn <a href="#method.sort_unstable_by_key" class="fn">sort_unstable_by_key</a><K, F>(&mut self, f: F)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> K,
|
|||
|
|
K: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Sorts the slice with a key extraction function, but might not preserve the order of equal
|
|||
|
|
elements.</p>
|
|||
|
|
<p>This sort is unstable (i.e., may reorder equal elements), in-place
|
|||
|
|
(i.e., does not allocate), and <em>O</em>(<em>m</em> * <em>n</em> * log(<em>n</em>)) worst-case, where the key function is
|
|||
|
|
<em>O</em>(<em>m</em>).</p>
|
|||
|
|
<h5 id="current-implementation-2"><a href="#current-implementation-2">Current implementation</a></h5>
|
|||
|
|
<p>The current algorithm is based on <a href="https://github.com/orlp/pdqsort">pattern-defeating quicksort</a> by Orson Peters,
|
|||
|
|
which combines the fast average case of randomized quicksort with the fast worst case of
|
|||
|
|
heapsort, while achieving linear time on slices with certain patterns. It uses some
|
|||
|
|
randomization to avoid degenerate cases, but with a fixed seed to always provide
|
|||
|
|
deterministic behavior.</p>
|
|||
|
|
<p>Due to its key calling strategy, <a href="#method.sort_unstable_by_key"><code>sort_unstable_by_key</code></a>
|
|||
|
|
is likely to be slower than <a href="#method.sort_by_cached_key"><code>sort_by_cached_key</code></a> in
|
|||
|
|
cases where the key function is expensive.</p>
|
|||
|
|
<h5 id="examples-84"><a href="#examples-84">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [-<span class="number">5i32</span>, <span class="number">4</span>, <span class="number">1</span>, -<span class="number">3</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
v.sort_unstable_by_key(|k| k.abs());
|
|||
|
|
<span class="macro">assert!</span>(v == [<span class="number">1</span>, <span class="number">2</span>, -<span class="number">3</span>, <span class="number">4</span>, -<span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.select_nth_unstable" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.49.0">1.49.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3092-3094">source</a></span><h4 class="code-header">pub fn <a href="#method.select_nth_unstable" class="fn">select_nth_unstable</a>(
|
|||
|
|
&mut self,
|
|||
|
|
index: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>
|
|||
|
|
) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)<div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Reorder the slice such that the element at <code>index</code> is at its final sorted position.</p>
|
|||
|
|
<p>This reordering has the additional property that any value at position <code>i < index</code> will be
|
|||
|
|
less than or equal to any value at a position <code>j > index</code>. Additionally, this reordering is
|
|||
|
|
unstable (i.e. any number of equal elements may end up at position <code>index</code>), in-place
|
|||
|
|
(i.e. does not allocate), and runs in <em>O</em>(<em>n</em>) time.
|
|||
|
|
This function is also known as “kth element” in other libraries.</p>
|
|||
|
|
<p>It returns a triplet of the following from the reordered slice:
|
|||
|
|
the subslice prior to <code>index</code>, the element at <code>index</code>, and the subslice after <code>index</code>;
|
|||
|
|
accordingly, the values in those two subslices will respectively all be less-than-or-equal-to
|
|||
|
|
and greater-than-or-equal-to the value of the element at <code>index</code>.</p>
|
|||
|
|
<h5 id="current-implementation-3"><a href="#current-implementation-3">Current implementation</a></h5>
|
|||
|
|
<p>The current algorithm is an introselect implementation based on Pattern Defeating Quicksort, which is also
|
|||
|
|
the basis for <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_unstable" title="method slice::sort_unstable"><code>sort_unstable</code></a>. The fallback algorithm is Median of Medians using Tukey’s Ninther for
|
|||
|
|
pivot selection, which guarantees linear runtime for all inputs.</p>
|
|||
|
|
<h5 id="panics-24"><a href="#panics-24">Panics</a></h5>
|
|||
|
|
<p>Panics when <code>index >= len()</code>, meaning it always panics on empty slices.</p>
|
|||
|
|
<h5 id="examples-85"><a href="#examples-85">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [-<span class="number">5i32</span>, <span class="number">4</span>, <span class="number">1</span>, -<span class="number">3</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="comment">// Find the median
|
|||
|
|
</span>v.select_nth_unstable(<span class="number">2</span>);
|
|||
|
|
|
|||
|
|
<span class="comment">// We are only guaranteed the slice will be one of the following, based on the way we sort
|
|||
|
|
// about the specified index.
|
|||
|
|
</span><span class="macro">assert!</span>(v == [-<span class="number">3</span>, -<span class="number">5</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>] ||
|
|||
|
|
v == [-<span class="number">5</span>, -<span class="number">3</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>] ||
|
|||
|
|
v == [-<span class="number">3</span>, -<span class="number">5</span>, <span class="number">1</span>, <span class="number">4</span>, <span class="number">2</span>] ||
|
|||
|
|
v == [-<span class="number">5</span>, -<span class="number">3</span>, <span class="number">1</span>, <span class="number">4</span>, <span class="number">2</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.select_nth_unstable_by" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.49.0">1.49.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3143-3149">source</a></span><h4 class="code-header">pub fn <a href="#method.select_nth_unstable_by" class="fn">select_nth_unstable_by</a><F>(
|
|||
|
|
&mut self,
|
|||
|
|
index: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>,
|
|||
|
|
compare: F
|
|||
|
|
) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>,</div></h4></section></summary><div class="docblock"><p>Reorder the slice with a comparator function such that the element at <code>index</code> is at its
|
|||
|
|
final sorted position.</p>
|
|||
|
|
<p>This reordering has the additional property that any value at position <code>i < index</code> will be
|
|||
|
|
less than or equal to any value at a position <code>j > index</code> using the comparator function.
|
|||
|
|
Additionally, this reordering is unstable (i.e. any number of equal elements may end up at
|
|||
|
|
position <code>index</code>), in-place (i.e. does not allocate), and runs in <em>O</em>(<em>n</em>) time.
|
|||
|
|
This function is also known as “kth element” in other libraries.</p>
|
|||
|
|
<p>It returns a triplet of the following from
|
|||
|
|
the slice reordered according to the provided comparator function: the subslice prior to
|
|||
|
|
<code>index</code>, the element at <code>index</code>, and the subslice after <code>index</code>; accordingly, the values in
|
|||
|
|
those two subslices will respectively all be less-than-or-equal-to and greater-than-or-equal-to
|
|||
|
|
the value of the element at <code>index</code>.</p>
|
|||
|
|
<h5 id="current-implementation-4"><a href="#current-implementation-4">Current implementation</a></h5>
|
|||
|
|
<p>The current algorithm is an introselect implementation based on Pattern Defeating Quicksort, which is also
|
|||
|
|
the basis for <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_unstable" title="method slice::sort_unstable"><code>sort_unstable</code></a>. The fallback algorithm is Median of Medians using Tukey’s Ninther for
|
|||
|
|
pivot selection, which guarantees linear runtime for all inputs.</p>
|
|||
|
|
<h5 id="panics-25"><a href="#panics-25">Panics</a></h5>
|
|||
|
|
<p>Panics when <code>index >= len()</code>, meaning it always panics on empty slices.</p>
|
|||
|
|
<h5 id="examples-86"><a href="#examples-86">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [-<span class="number">5i32</span>, <span class="number">4</span>, <span class="number">1</span>, -<span class="number">3</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="comment">// Find the median as if the slice were sorted in descending order.
|
|||
|
|
</span>v.select_nth_unstable_by(<span class="number">2</span>, |a, b| b.cmp(a));
|
|||
|
|
|
|||
|
|
<span class="comment">// We are only guaranteed the slice will be one of the following, based on the way we sort
|
|||
|
|
// about the specified index.
|
|||
|
|
</span><span class="macro">assert!</span>(v == [<span class="number">2</span>, <span class="number">4</span>, <span class="number">1</span>, -<span class="number">5</span>, -<span class="number">3</span>] ||
|
|||
|
|
v == [<span class="number">2</span>, <span class="number">4</span>, <span class="number">1</span>, -<span class="number">3</span>, -<span class="number">5</span>] ||
|
|||
|
|
v == [<span class="number">4</span>, <span class="number">2</span>, <span class="number">1</span>, -<span class="number">5</span>, -<span class="number">3</span>] ||
|
|||
|
|
v == [<span class="number">4</span>, <span class="number">2</span>, <span class="number">1</span>, -<span class="number">3</span>, -<span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.select_nth_unstable_by_key" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.49.0">1.49.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3198-3205">source</a></span><h4 class="code-header">pub fn <a href="#method.select_nth_unstable_by_key" class="fn">select_nth_unstable_by_key</a><K, F>(
|
|||
|
|
&mut self,
|
|||
|
|
index: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>,
|
|||
|
|
f: F
|
|||
|
|
) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> K,
|
|||
|
|
K: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Reorder the slice with a key extraction function such that the element at <code>index</code> is at its
|
|||
|
|
final sorted position.</p>
|
|||
|
|
<p>This reordering has the additional property that any value at position <code>i < index</code> will be
|
|||
|
|
less than or equal to any value at a position <code>j > index</code> using the key extraction function.
|
|||
|
|
Additionally, this reordering is unstable (i.e. any number of equal elements may end up at
|
|||
|
|
position <code>index</code>), in-place (i.e. does not allocate), and runs in <em>O</em>(<em>n</em>) time.
|
|||
|
|
This function is also known as “kth element” in other libraries.</p>
|
|||
|
|
<p>It returns a triplet of the following from
|
|||
|
|
the slice reordered according to the provided key extraction function: the subslice prior to
|
|||
|
|
<code>index</code>, the element at <code>index</code>, and the subslice after <code>index</code>; accordingly, the values in
|
|||
|
|
those two subslices will respectively all be less-than-or-equal-to and greater-than-or-equal-to
|
|||
|
|
the value of the element at <code>index</code>.</p>
|
|||
|
|
<h5 id="current-implementation-5"><a href="#current-implementation-5">Current implementation</a></h5>
|
|||
|
|
<p>The current algorithm is an introselect implementation based on Pattern Defeating Quicksort, which is also
|
|||
|
|
the basis for <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_unstable" title="method slice::sort_unstable"><code>sort_unstable</code></a>. The fallback algorithm is Median of Medians using Tukey’s Ninther for
|
|||
|
|
pivot selection, which guarantees linear runtime for all inputs.</p>
|
|||
|
|
<h5 id="panics-26"><a href="#panics-26">Panics</a></h5>
|
|||
|
|
<p>Panics when <code>index >= len()</code>, meaning it always panics on empty slices.</p>
|
|||
|
|
<h5 id="examples-87"><a href="#examples-87">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [-<span class="number">5i32</span>, <span class="number">4</span>, <span class="number">1</span>, -<span class="number">3</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
<span class="comment">// Return the median as if the array were sorted according to absolute value.
|
|||
|
|
</span>v.select_nth_unstable_by_key(<span class="number">2</span>, |a| a.abs());
|
|||
|
|
|
|||
|
|
<span class="comment">// We are only guaranteed the slice will be one of the following, based on the way we sort
|
|||
|
|
// about the specified index.
|
|||
|
|
</span><span class="macro">assert!</span>(v == [<span class="number">1</span>, <span class="number">2</span>, -<span class="number">3</span>, <span class="number">4</span>, -<span class="number">5</span>] ||
|
|||
|
|
v == [<span class="number">1</span>, <span class="number">2</span>, -<span class="number">3</span>, -<span class="number">5</span>, <span class="number">4</span>] ||
|
|||
|
|
v == [<span class="number">2</span>, <span class="number">1</span>, -<span class="number">3</span>, <span class="number">4</span>, -<span class="number">5</span>] ||
|
|||
|
|
v == [<span class="number">2</span>, <span class="number">1</span>, -<span class="number">3</span>, -<span class="number">5</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.partition_dedup" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3232-3234">source</a><h4 class="code-header">pub fn <a href="#method.partition_dedup" class="fn">partition_dedup</a>(&mut self) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)<div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_partition_dedup</code>)</span></div></span></summary><div class="docblock"><p>Moves all consecutive repeated elements to the end of the slice according to the
|
|||
|
|
<a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq"><code>PartialEq</code></a> trait implementation.</p>
|
|||
|
|
<p>Returns two slices. The first contains no consecutive repeated elements.
|
|||
|
|
The second contains all the duplicates in no specified order.</p>
|
|||
|
|
<p>If the slice is sorted, the first returned slice contains no duplicates.</p>
|
|||
|
|
<h5 id="examples-88"><a href="#examples-88">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_partition_dedup)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">1</span>, <span class="number">1</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>(dedup, duplicates) = slice.partition_dedup();
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(dedup, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">1</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(duplicates, [<span class="number">2</span>, <span class="number">3</span>, <span class="number">1</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.partition_dedup_by" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3266-3268">source</a><h4 class="code-header">pub fn <a href="#method.partition_dedup_by" class="fn">partition_dedup_by</a><F>(&mut self, same_bucket: F) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_partition_dedup</code>)</span></div></span></summary><div class="docblock"><p>Moves all but the first of consecutive elements to the end of the slice satisfying
|
|||
|
|
a given equality relation.</p>
|
|||
|
|
<p>Returns two slices. The first contains no consecutive repeated elements.
|
|||
|
|
The second contains all the duplicates in no specified order.</p>
|
|||
|
|
<p>The <code>same_bucket</code> function is passed references to two elements from the slice and
|
|||
|
|
must determine if the elements compare equal. The elements are passed in opposite order
|
|||
|
|
from their order in the slice, so if <code>same_bucket(a, b)</code> returns <code>true</code>, <code>a</code> is moved
|
|||
|
|
at the end of the slice.</p>
|
|||
|
|
<p>If the slice is sorted, the first returned slice contains no duplicates.</p>
|
|||
|
|
<h5 id="examples-89"><a href="#examples-89">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_partition_dedup)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice = [<span class="string">"foo"</span>, <span class="string">"Foo"</span>, <span class="string">"BAZ"</span>, <span class="string">"Bar"</span>, <span class="string">"bar"</span>, <span class="string">"baz"</span>, <span class="string">"BAZ"</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>(dedup, duplicates) = slice.partition_dedup_by(|a, b| a.eq_ignore_ascii_case(b));
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(dedup, [<span class="string">"foo"</span>, <span class="string">"BAZ"</span>, <span class="string">"Bar"</span>, <span class="string">"baz"</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(duplicates, [<span class="string">"bar"</span>, <span class="string">"Foo"</span>, <span class="string">"BAZ"</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.partition_dedup_by_key" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3392-3395">source</a><h4 class="code-header">pub fn <a href="#method.partition_dedup_by_key" class="fn">partition_dedup_by_key</a><K, F>(&mut self, key: F) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>) -> K,
|
|||
|
|
K: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_partition_dedup</code>)</span></div></span></summary><div class="docblock"><p>Moves all but the first of consecutive elements to the end of the slice that resolve
|
|||
|
|
to the same key.</p>
|
|||
|
|
<p>Returns two slices. The first contains no consecutive repeated elements.
|
|||
|
|
The second contains all the duplicates in no specified order.</p>
|
|||
|
|
<p>If the slice is sorted, the first returned slice contains no duplicates.</p>
|
|||
|
|
<h5 id="examples-90"><a href="#examples-90">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_partition_dedup)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice = [<span class="number">10</span>, <span class="number">20</span>, <span class="number">21</span>, <span class="number">30</span>, <span class="number">30</span>, <span class="number">20</span>, <span class="number">11</span>, <span class="number">13</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>(dedup, duplicates) = slice.partition_dedup_by_key(|i| <span class="kw-2">*</span>i / <span class="number">10</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(dedup, [<span class="number">10</span>, <span class="number">20</span>, <span class="number">30</span>, <span class="number">20</span>, <span class="number">11</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(duplicates, [<span class="number">21</span>, <span class="number">30</span>, <span class="number">13</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rotate_left" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.26.0">1.26.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3431">source</a></span><h4 class="code-header">pub fn <a href="#method.rotate_left" class="fn">rotate_left</a>(&mut self, mid: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Rotates the slice in-place such that the first <code>mid</code> elements of the
|
|||
|
|
slice move to the end while the last <code>self.len() - mid</code> elements move to
|
|||
|
|
the front. After calling <code>rotate_left</code>, the element previously at index
|
|||
|
|
<code>mid</code> will become the first element in the slice.</p>
|
|||
|
|
<h5 id="panics-27"><a href="#panics-27">Panics</a></h5>
|
|||
|
|
<p>This function will panic if <code>mid</code> is greater than the length of the
|
|||
|
|
slice. Note that <code>mid == self.len()</code> does <em>not</em> panic and is a no-op
|
|||
|
|
rotation.</p>
|
|||
|
|
<h5 id="complexity"><a href="#complexity">Complexity</a></h5>
|
|||
|
|
<p>Takes linear (in <code>self.len()</code>) time.</p>
|
|||
|
|
<h5 id="examples-91"><a href="#examples-91">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>a = [<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>, <span class="string">'e'</span>, <span class="string">'f'</span>];
|
|||
|
|
a.rotate_left(<span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(a, [<span class="string">'c'</span>, <span class="string">'d'</span>, <span class="string">'e'</span>, <span class="string">'f'</span>, <span class="string">'a'</span>, <span class="string">'b'</span>]);</code></pre></div>
|
|||
|
|
<p>Rotating a subslice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>a = [<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>, <span class="string">'e'</span>, <span class="string">'f'</span>];
|
|||
|
|
a[<span class="number">1</span>..<span class="number">5</span>].rotate_left(<span class="number">1</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(a, [<span class="string">'a'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>, <span class="string">'e'</span>, <span class="string">'b'</span>, <span class="string">'f'</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rotate_right" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.26.0">1.26.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3474">source</a></span><h4 class="code-header">pub fn <a href="#method.rotate_right" class="fn">rotate_right</a>(&mut self, k: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Rotates the slice in-place such that the first <code>self.len() - k</code>
|
|||
|
|
elements of the slice move to the end while the last <code>k</code> elements move
|
|||
|
|
to the front. After calling <code>rotate_right</code>, the element previously at
|
|||
|
|
index <code>self.len() - k</code> will become the first element in the slice.</p>
|
|||
|
|
<h5 id="panics-28"><a href="#panics-28">Panics</a></h5>
|
|||
|
|
<p>This function will panic if <code>k</code> is greater than the length of the
|
|||
|
|
slice. Note that <code>k == self.len()</code> does <em>not</em> panic and is a no-op
|
|||
|
|
rotation.</p>
|
|||
|
|
<h5 id="complexity-1"><a href="#complexity-1">Complexity</a></h5>
|
|||
|
|
<p>Takes linear (in <code>self.len()</code>) time.</p>
|
|||
|
|
<h5 id="examples-92"><a href="#examples-92">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>a = [<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>, <span class="string">'e'</span>, <span class="string">'f'</span>];
|
|||
|
|
a.rotate_right(<span class="number">2</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(a, [<span class="string">'e'</span>, <span class="string">'f'</span>, <span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>]);</code></pre></div>
|
|||
|
|
<p>Rotating a subslice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>a = [<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>, <span class="string">'e'</span>, <span class="string">'f'</span>];
|
|||
|
|
a[<span class="number">1</span>..<span class="number">5</span>].rotate_right(<span class="number">1</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(a, [<span class="string">'a'</span>, <span class="string">'e'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>, <span class="string">'f'</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.fill" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.50.0">1.50.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3497-3499">source</a></span><h4 class="code-header">pub fn <a href="#method.fill" class="fn">fill</a>(&mut self, value: T)<div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class="docblock"><p>Fills <code>self</code> with elements by cloning <code>value</code>.</p>
|
|||
|
|
<h5 id="examples-93"><a href="#examples-93">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">10</span>];
|
|||
|
|
buf.fill(<span class="number">1</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(buf, <span class="macro">vec!</span>[<span class="number">1</span>; <span class="number">10</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.fill_with" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.51.0">1.51.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3521-3523">source</a></span><h4 class="code-header">pub fn <a href="#method.fill_with" class="fn">fill_with</a><F>(&mut self, f: F)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>() -> T,</div></h4></section></summary><div class="docblock"><p>Fills <code>self</code> with elements returned by calling a closure repeatedly.</p>
|
|||
|
|
<p>This method uses a closure to create new values. If you’d rather
|
|||
|
|
<a href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone"><code>Clone</code></a> a given value, use <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.fill" title="method slice::fill"><code>fill</code></a>. If you want to use the <a href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default"><code>Default</code></a>
|
|||
|
|
trait to generate values, you can pass <a href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html#tymethod.default" title="associated function core::default::Default::default"><code>Default::default</code></a> as the
|
|||
|
|
argument.</p>
|
|||
|
|
<h5 id="examples-94"><a href="#examples-94">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="macro">vec!</span>[<span class="number">1</span>; <span class="number">10</span>];
|
|||
|
|
buf.fill_with(Default::default);
|
|||
|
|
<span class="macro">assert_eq!</span>(buf, <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">10</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from_slice" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.7.0">1.7.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3584-3586">source</a></span><h4 class="code-header">pub fn <a href="#method.clone_from_slice" class="fn">clone_from_slice</a>(&mut self, src: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)<div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class="docblock"><p>Copies the elements from <code>src</code> into <code>self</code>.</p>
|
|||
|
|
<p>The length of <code>src</code> must be the same as <code>self</code>.</p>
|
|||
|
|
<h5 id="panics-29"><a href="#panics-29">Panics</a></h5>
|
|||
|
|
<p>This function will panic if the two slices have different lengths.</p>
|
|||
|
|
<h5 id="examples-95"><a href="#examples-95">Examples</a></h5>
|
|||
|
|
<p>Cloning two elements from a slice into another:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>src = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>dst = [<span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
|
|||
|
|
<span class="comment">// Because the slices have to be the same length,
|
|||
|
|
// we slice the source slice from four elements
|
|||
|
|
// to two. It will panic if we don't do this.
|
|||
|
|
</span>dst.clone_from_slice(<span class="kw-2">&</span>src[<span class="number">2</span>..]);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(src, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(dst, [<span class="number">3</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
<p>Rust enforces that there can only be one mutable reference with no
|
|||
|
|
immutable references to a particular piece of data in a particular
|
|||
|
|
scope. Because of this, attempting to use <code>clone_from_slice</code> on a
|
|||
|
|
single slice will result in a compile failure:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>slice = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
|
|||
|
|
|
|||
|
|
slice[..<span class="number">2</span>].clone_from_slice(<span class="kw-2">&</span>slice[<span class="number">3</span>..]); <span class="comment">// compile fail!</span></code></pre></div>
|
|||
|
|
<p>To work around this, we can use <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.split_at_mut" title="method slice::split_at_mut"><code>split_at_mut</code></a> to create two distinct
|
|||
|
|
sub-slices from a slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>slice = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = slice.split_at_mut(<span class="number">2</span>);
|
|||
|
|
left.clone_from_slice(<span class="kw-2">&</span>right[<span class="number">1</span>..]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, [<span class="number">4</span>, <span class="number">5</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.copy_from_slice" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.9.0">1.9.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3648-3650">source</a></span><h4 class="code-header">pub fn <a href="#method.copy_from_slice" class="fn">copy_from_slice</a>(&mut self, src: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)<div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,</div></h4></section></summary><div class="docblock"><p>Copies all elements from <code>src</code> into <code>self</code>, using a memcpy.</p>
|
|||
|
|
<p>The length of <code>src</code> must be the same as <code>self</code>.</p>
|
|||
|
|
<p>If <code>T</code> does not implement <code>Copy</code>, use <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.clone_from_slice" title="method slice::clone_from_slice"><code>clone_from_slice</code></a>.</p>
|
|||
|
|
<h5 id="panics-30"><a href="#panics-30">Panics</a></h5>
|
|||
|
|
<p>This function will panic if the two slices have different lengths.</p>
|
|||
|
|
<h5 id="examples-96"><a href="#examples-96">Examples</a></h5>
|
|||
|
|
<p>Copying two elements from a slice into another:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>src = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>dst = [<span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
|
|||
|
|
<span class="comment">// Because the slices have to be the same length,
|
|||
|
|
// we slice the source slice from four elements
|
|||
|
|
// to two. It will panic if we don't do this.
|
|||
|
|
</span>dst.copy_from_slice(<span class="kw-2">&</span>src[<span class="number">2</span>..]);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(src, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(dst, [<span class="number">3</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
<p>Rust enforces that there can only be one mutable reference with no
|
|||
|
|
immutable references to a particular piece of data in a particular
|
|||
|
|
scope. Because of this, attempting to use <code>copy_from_slice</code> on a
|
|||
|
|
single slice will result in a compile failure:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>slice = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
|
|||
|
|
|
|||
|
|
slice[..<span class="number">2</span>].copy_from_slice(<span class="kw-2">&</span>slice[<span class="number">3</span>..]); <span class="comment">// compile fail!</span></code></pre></div>
|
|||
|
|
<p>To work around this, we can use <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.split_at_mut" title="method slice::split_at_mut"><code>split_at_mut</code></a> to create two distinct
|
|||
|
|
sub-slices from a slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>slice = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = slice.split_at_mut(<span class="number">2</span>);
|
|||
|
|
left.copy_from_slice(<span class="kw-2">&</span>right[<span class="number">1</span>..]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, [<span class="number">4</span>, <span class="number">5</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.copy_within" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.37.0">1.37.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3702-3704">source</a></span><h4 class="code-header">pub fn <a href="#method.copy_within" class="fn">copy_within</a><R>(&mut self, src: R, dest: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>)<div class="where">where
|
|||
|
|
R: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/range/trait.RangeBounds.html" title="trait core::ops::range::RangeBounds">RangeBounds</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>,
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,</div></h4></section></summary><div class="docblock"><p>Copies elements from one part of the slice to another part of itself,
|
|||
|
|
using a memmove.</p>
|
|||
|
|
<p><code>src</code> is the range within <code>self</code> to copy from. <code>dest</code> is the starting
|
|||
|
|
index of the range within <code>self</code> to copy to, which will have the same
|
|||
|
|
length as <code>src</code>. The two ranges may overlap. The ends of the two ranges
|
|||
|
|
must be less than or equal to <code>self.len()</code>.</p>
|
|||
|
|
<h5 id="panics-31"><a href="#panics-31">Panics</a></h5>
|
|||
|
|
<p>This function will panic if either range exceeds the end of the slice,
|
|||
|
|
or if the end of <code>src</code> is before the start.</p>
|
|||
|
|
<h5 id="examples-97"><a href="#examples-97">Examples</a></h5>
|
|||
|
|
<p>Copying four bytes within a slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>bytes = <span class="kw-2">*</span><span class="string">b"Hello, World!"</span>;
|
|||
|
|
|
|||
|
|
bytes.copy_within(<span class="number">1</span>..<span class="number">5</span>, <span class="number">8</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>bytes, <span class="string">b"Hello, Wello!"</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.swap_with_slice" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.27.0">1.27.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3769">source</a></span><h4 class="code-header">pub fn <a href="#method.swap_with_slice" class="fn">swap_with_slice</a>(&mut self, other: &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section></summary><div class="docblock"><p>Swaps all elements in <code>self</code> with those in <code>other</code>.</p>
|
|||
|
|
<p>The length of <code>other</code> must be the same as <code>self</code>.</p>
|
|||
|
|
<h5 id="panics-32"><a href="#panics-32">Panics</a></h5>
|
|||
|
|
<p>This function will panic if the two slices have different lengths.</p>
|
|||
|
|
<h5 id="example-2"><a href="#example-2">Example</a></h5>
|
|||
|
|
<p>Swapping two elements across slices:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>slice1 = [<span class="number">0</span>, <span class="number">0</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>slice2 = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>];
|
|||
|
|
|
|||
|
|
slice1.swap_with_slice(<span class="kw-2">&mut </span>slice2[<span class="number">2</span>..]);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice1, [<span class="number">3</span>, <span class="number">4</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(slice2, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">0</span>]);</code></pre></div>
|
|||
|
|
<p>Rust enforces that there can only be one mutable reference to a
|
|||
|
|
particular piece of data in a particular scope. Because of this,
|
|||
|
|
attempting to use <code>swap_with_slice</code> on a single slice will result in
|
|||
|
|
a compile failure:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>slice = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
|
|||
|
|
slice[..<span class="number">2</span>].swap_with_slice(<span class="kw-2">&mut </span>slice[<span class="number">3</span>..]); <span class="comment">// compile fail!</span></code></pre></div>
|
|||
|
|
<p>To work around this, we can use <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.split_at_mut" title="method slice::split_at_mut"><code>split_at_mut</code></a> to create two distinct
|
|||
|
|
mutable sub-slices from a slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>slice = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
|
|||
|
|
|
|||
|
|
{
|
|||
|
|
<span class="kw">let </span>(left, right) = slice.split_at_mut(<span class="number">2</span>);
|
|||
|
|
left.swap_with_slice(<span class="kw-2">&mut </span>right[<span class="number">1</span>..]);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, [<span class="number">4</span>, <span class="number">5</span>, <span class="number">3</span>, <span class="number">1</span>, <span class="number">2</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.align_to" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.30.0">1.30.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3849">source</a></span><h4 class="code-header">pub unsafe fn <a href="#method.align_to" class="fn">align_to</a><U>(&self) -> (&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[U]</a>, &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section></summary><div class="docblock"><p>Transmute the slice to a slice of another type, ensuring alignment of the types is
|
|||
|
|
maintained.</p>
|
|||
|
|
<p>This method splits the slice into three distinct slices: prefix, correctly aligned middle
|
|||
|
|
slice of a new type, and the suffix slice. How exactly the slice is split up is not
|
|||
|
|
specified; the middle part may be smaller than necessary. However, if this fails to return a
|
|||
|
|
maximal middle part, that is because code is running in a context where performance does not
|
|||
|
|
matter, such as a sanitizer attempting to find alignment bugs. Regular code running
|
|||
|
|
in a default (debug or release) execution <em>will</em> return a maximal middle part.</p>
|
|||
|
|
<p>This method has no purpose when either input element <code>T</code> or output element <code>U</code> are
|
|||
|
|
zero-sized and will return the original slice without splitting anything.</p>
|
|||
|
|
<h5 id="safety-9"><a href="#safety-9">Safety</a></h5>
|
|||
|
|
<p>This method is essentially a <code>transmute</code> with respect to the elements in the returned
|
|||
|
|
middle slice, so all the usual caveats pertaining to <code>transmute::<T, U></code> also apply here.</p>
|
|||
|
|
<h5 id="examples-98"><a href="#examples-98">Examples</a></h5>
|
|||
|
|
<p>Basic usage:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">unsafe </span>{
|
|||
|
|
<span class="kw">let </span>bytes: [u8; <span class="number">7</span>] = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>];
|
|||
|
|
<span class="kw">let </span>(prefix, shorts, suffix) = bytes.align_to::<u16>();
|
|||
|
|
<span class="comment">// less_efficient_algorithm_for_bytes(prefix);
|
|||
|
|
// more_efficient_algorithm_for_aligned_shorts(shorts);
|
|||
|
|
// less_efficient_algorithm_for_bytes(suffix);
|
|||
|
|
</span>}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.align_to_mut" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.30.0">1.30.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#3917">source</a></span><h4 class="code-header">pub unsafe fn <a href="#method.align_to_mut" class="fn">align_to_mut</a><U>(&mut self) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[U]</a>, &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)</h4></section></summary><div class="docblock"><p>Transmute the mutable slice to a mutable slice of another type, ensuring alignment of the
|
|||
|
|
types is maintained.</p>
|
|||
|
|
<p>This method splits the slice into three distinct slices: prefix, correctly aligned middle
|
|||
|
|
slice of a new type, and the suffix slice. How exactly the slice is split up is not
|
|||
|
|
specified; the middle part may be smaller than necessary. However, if this fails to return a
|
|||
|
|
maximal middle part, that is because code is running in a context where performance does not
|
|||
|
|
matter, such as a sanitizer attempting to find alignment bugs. Regular code running
|
|||
|
|
in a default (debug or release) execution <em>will</em> return a maximal middle part.</p>
|
|||
|
|
<p>This method has no purpose when either input element <code>T</code> or output element <code>U</code> are
|
|||
|
|
zero-sized and will return the original slice without splitting anything.</p>
|
|||
|
|
<h5 id="safety-10"><a href="#safety-10">Safety</a></h5>
|
|||
|
|
<p>This method is essentially a <code>transmute</code> with respect to the elements in the returned
|
|||
|
|
middle slice, so all the usual caveats pertaining to <code>transmute::<T, U></code> also apply here.</p>
|
|||
|
|
<h5 id="examples-99"><a href="#examples-99">Examples</a></h5>
|
|||
|
|
<p>Basic usage:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">unsafe </span>{
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>bytes: [u8; <span class="number">7</span>] = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>];
|
|||
|
|
<span class="kw">let </span>(prefix, shorts, suffix) = bytes.align_to_mut::<u16>();
|
|||
|
|
<span class="comment">// less_efficient_algorithm_for_bytes(prefix);
|
|||
|
|
// more_efficient_algorithm_for_aligned_shorts(shorts);
|
|||
|
|
// less_efficient_algorithm_for_bytes(suffix);
|
|||
|
|
</span>}</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_simd" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4017-4021">source</a><h4 class="code-header">pub fn <a href="#method.as_simd" class="fn">as_simd</a><const LANES: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(&self) -> (&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &[<a class="struct" href="https://doc.rust-lang.org/1.76.0/core/core_simd/vector/struct.Simd.html" title="struct core::core_simd::vector::Simd">Simd</a><T, LANES>], &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)<div class="where">where
|
|||
|
|
<a class="struct" href="https://doc.rust-lang.org/1.76.0/core/core_simd/vector/struct.Simd.html" title="struct core::core_simd::vector::Simd">Simd</a><T, LANES>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; LANES]</a>>,
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/core_simd/vector/trait.SimdElement.html" title="trait core::core_simd::vector::SimdElement">SimdElement</a>,
|
|||
|
|
<a class="struct" href="https://doc.rust-lang.org/1.76.0/core/core_simd/lane_count/struct.LaneCount.html" title="struct core::core_simd::lane_count::LaneCount">LaneCount</a><LANES>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/core_simd/lane_count/trait.SupportedLaneCount.html" title="trait core::core_simd::lane_count::SupportedLaneCount">SupportedLaneCount</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>portable_simd</code>)</span></div></span></summary><div class="docblock"><p>Split a slice into a prefix, a middle of aligned SIMD types, and a suffix.</p>
|
|||
|
|
<p>This is a safe wrapper around <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.align_to" title="method slice::align_to"><code>slice::align_to</code></a>, so has the same weak
|
|||
|
|
postconditions as that method. You’re only assured that
|
|||
|
|
<code>self.len() == prefix.len() + middle.len() * LANES + suffix.len()</code>.</p>
|
|||
|
|
<p>Notably, all of the following are possible:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>prefix.len() >= LANES</code>.</li>
|
|||
|
|
<li><code>middle.is_empty()</code> despite <code>self.len() >= 3 * LANES</code>.</li>
|
|||
|
|
<li><code>suffix.len() >= LANES</code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>That said, this is a safe method, so if you’re only writing safe code,
|
|||
|
|
then this can at most cause incorrect logic, not unsoundness.</p>
|
|||
|
|
<h5 id="panics-33"><a href="#panics-33">Panics</a></h5>
|
|||
|
|
<p>This will panic if the size of the SIMD type is different from
|
|||
|
|
<code>LANES</code> times that of the scalar.</p>
|
|||
|
|
<p>At the time of writing, the trait restrictions on <code>Simd<T, LANES></code> keeps
|
|||
|
|
that from ever happening, as only power-of-two numbers of lanes are
|
|||
|
|
supported. It’s possible that, in the future, those restrictions might
|
|||
|
|
be lifted in a way that would make it possible to see panics from this
|
|||
|
|
method for something like <code>LANES == 3</code>.</p>
|
|||
|
|
<h5 id="examples-100"><a href="#examples-100">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(portable_simd)]
|
|||
|
|
</span><span class="kw">use </span>core::simd::prelude::<span class="kw-2">*</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>short = <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|||
|
|
<span class="kw">let </span>(prefix, middle, suffix) = short.as_simd::<<span class="number">4</span>>();
|
|||
|
|
<span class="macro">assert_eq!</span>(middle, []); <span class="comment">// Not enough elements for anything in the middle
|
|||
|
|
|
|||
|
|
// They might be split in any possible way between prefix and suffix
|
|||
|
|
</span><span class="kw">let </span>it = prefix.iter().chain(suffix).copied();
|
|||
|
|
<span class="macro">assert_eq!</span>(it.collect::<Vec<<span class="kw">_</span>>>(), <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]);
|
|||
|
|
|
|||
|
|
<span class="kw">fn </span>basic_simd_sum(x: <span class="kw-2">&</span>[f32]) -> f32 {
|
|||
|
|
<span class="kw">use </span>std::ops::Add;
|
|||
|
|
<span class="kw">let </span>(prefix, middle, suffix) = x.as_simd();
|
|||
|
|
<span class="kw">let </span>sums = f32x4::from_array([
|
|||
|
|
prefix.iter().copied().sum(),
|
|||
|
|
<span class="number">0.0</span>,
|
|||
|
|
<span class="number">0.0</span>,
|
|||
|
|
suffix.iter().copied().sum(),
|
|||
|
|
]);
|
|||
|
|
<span class="kw">let </span>sums = middle.iter().copied().fold(sums, f32x4::add);
|
|||
|
|
sums.reduce_sum()
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>numbers: Vec<f32> = (<span class="number">1</span>..<span class="number">101</span>).map(|x| x <span class="kw">as _</span>).collect();
|
|||
|
|
<span class="macro">assert_eq!</span>(basic_simd_sum(<span class="kw-2">&</span>numbers[<span class="number">1</span>..<span class="number">99</span>]), <span class="number">4949.0</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_simd_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4062-4066">source</a><h4 class="code-header">pub fn <a href="#method.as_simd_mut" class="fn">as_simd_mut</a><const LANES: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(
|
|||
|
|
&mut self
|
|||
|
|
) -> (&mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, &mut [<a class="struct" href="https://doc.rust-lang.org/1.76.0/core/core_simd/vector/struct.Simd.html" title="struct core::core_simd::vector::Simd">Simd</a><T, LANES>], &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>)<div class="where">where
|
|||
|
|
<a class="struct" href="https://doc.rust-lang.org/1.76.0/core/core_simd/vector/struct.Simd.html" title="struct core::core_simd::vector::Simd">Simd</a><T, LANES>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">[T; LANES]</a>>,
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/core_simd/vector/trait.SimdElement.html" title="trait core::core_simd::vector::SimdElement">SimdElement</a>,
|
|||
|
|
<a class="struct" href="https://doc.rust-lang.org/1.76.0/core/core_simd/lane_count/struct.LaneCount.html" title="struct core::core_simd::lane_count::LaneCount">LaneCount</a><LANES>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/core_simd/lane_count/trait.SupportedLaneCount.html" title="trait core::core_simd::lane_count::SupportedLaneCount">SupportedLaneCount</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>portable_simd</code>)</span></div></span></summary><div class="docblock"><p>Split a mutable slice into a mutable prefix, a middle of aligned SIMD types,
|
|||
|
|
and a mutable suffix.</p>
|
|||
|
|
<p>This is a safe wrapper around <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.align_to_mut" title="method slice::align_to_mut"><code>slice::align_to_mut</code></a>, so has the same weak
|
|||
|
|
postconditions as that method. You’re only assured that
|
|||
|
|
<code>self.len() == prefix.len() + middle.len() * LANES + suffix.len()</code>.</p>
|
|||
|
|
<p>Notably, all of the following are possible:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>prefix.len() >= LANES</code>.</li>
|
|||
|
|
<li><code>middle.is_empty()</code> despite <code>self.len() >= 3 * LANES</code>.</li>
|
|||
|
|
<li><code>suffix.len() >= LANES</code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>That said, this is a safe method, so if you’re only writing safe code,
|
|||
|
|
then this can at most cause incorrect logic, not unsoundness.</p>
|
|||
|
|
<p>This is the mutable version of <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.as_simd" title="method slice::as_simd"><code>slice::as_simd</code></a>; see that for examples.</p>
|
|||
|
|
<h5 id="panics-34"><a href="#panics-34">Panics</a></h5>
|
|||
|
|
<p>This will panic if the size of the SIMD type is different from
|
|||
|
|
<code>LANES</code> times that of the scalar.</p>
|
|||
|
|
<p>At the time of writing, the trait restrictions on <code>Simd<T, LANES></code> keeps
|
|||
|
|
that from ever happening, as only power-of-two numbers of lanes are
|
|||
|
|
supported. It’s possible that, in the future, those restrictions might
|
|||
|
|
be lifted in a way that would make it possible to see panics from this
|
|||
|
|
method for something like <code>LANES == 3</code>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_sorted" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4102-4104">source</a><h4 class="code-header">pub fn <a href="#method.is_sorted" class="fn">is_sorted</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a><div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>is_sorted</code>)</span></div></span></summary><div class="docblock"><p>Checks if the elements of this slice are sorted.</p>
|
|||
|
|
<p>That is, for each element <code>a</code> and its following element <code>b</code>, <code>a <= b</code> must hold. If the
|
|||
|
|
slice yields exactly zero or one element, <code>true</code> is returned.</p>
|
|||
|
|
<p>Note that if <code>Self::Item</code> is only <code>PartialOrd</code>, but not <code>Ord</code>, the above definition
|
|||
|
|
implies that this function returns <code>false</code> if any two consecutive items are not
|
|||
|
|
comparable.</p>
|
|||
|
|
<h5 id="examples-101"><a href="#examples-101">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(is_sorted)]
|
|||
|
|
</span><span class="kw">let </span>empty: [i32; <span class="number">0</span>] = [];
|
|||
|
|
|
|||
|
|
<span class="macro">assert!</span>([<span class="number">1</span>, <span class="number">2</span>, <span class="number">2</span>, <span class="number">9</span>].is_sorted());
|
|||
|
|
<span class="macro">assert!</span>(![<span class="number">1</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">4</span>].is_sorted());
|
|||
|
|
<span class="macro">assert!</span>([<span class="number">0</span>].is_sorted());
|
|||
|
|
<span class="macro">assert!</span>(empty.is_sorted());
|
|||
|
|
<span class="macro">assert!</span>(![<span class="number">0.0</span>, <span class="number">1.0</span>, f32::NAN].is_sorted());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_sorted_by" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4118-4120">source</a><h4 class="code-header">pub fn <a href="#method.is_sorted_by" class="fn">is_sorted_by</a><'a, F>(&'a self, compare: F) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'a T</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'a T</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>is_sorted</code>)</span></div></span></summary><div class="docblock"><p>Checks if the elements of this slice are sorted using the given comparator function.</p>
|
|||
|
|
<p>Instead of using <code>PartialOrd::partial_cmp</code>, this function uses the given <code>compare</code>
|
|||
|
|
function to determine the ordering of two elements. Apart from that, it’s equivalent to
|
|||
|
|
<a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.is_sorted" title="method slice::is_sorted"><code>is_sorted</code></a>; see its documentation for more information.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_sorted_by_key" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4144-4147">source</a><h4 class="code-header">pub fn <a href="#method.is_sorted_by_key" class="fn">is_sorted_by_key</a><'a, F, K>(&'a self, f: F) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a><div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'a T</a>) -> K,
|
|||
|
|
K: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>is_sorted</code>)</span></div></span></summary><div class="docblock"><p>Checks if the elements of this slice are sorted using the given key extraction function.</p>
|
|||
|
|
<p>Instead of comparing the slice’s elements directly, this function compares the keys of the
|
|||
|
|
elements, as determined by <code>f</code>. Apart from that, it’s equivalent to <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.is_sorted" title="method slice::is_sorted"><code>is_sorted</code></a>; see its
|
|||
|
|
documentation for more information.</p>
|
|||
|
|
<h5 id="examples-102"><a href="#examples-102">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(is_sorted)]
|
|||
|
|
|
|||
|
|
</span><span class="macro">assert!</span>([<span class="string">"c"</span>, <span class="string">"bb"</span>, <span class="string">"aaa"</span>].is_sorted_by_key(|s| s.len()));
|
|||
|
|
<span class="macro">assert!</span>(![-<span class="number">2i32</span>, -<span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>].is_sorted_by_key(|n| n.abs()));</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.partition_point" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.52.0">1.52.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4203-4205">source</a></span><h4 class="code-header">pub fn <a href="#method.partition_point" class="fn">partition_point</a><P>(&self, pred: P) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a><div class="where">where
|
|||
|
|
P: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Returns the index of the partition point according to the given predicate
|
|||
|
|
(the index of the first element of the second partition).</p>
|
|||
|
|
<p>The slice is assumed to be partitioned according to the given predicate.
|
|||
|
|
This means that all elements for which the predicate returns true are at the start of the slice
|
|||
|
|
and all elements for which the predicate returns false are at the end.
|
|||
|
|
For example, <code>[7, 15, 3, 5, 4, 12, 6]</code> is partitioned under the predicate <code>x % 2 != 0</code>
|
|||
|
|
(all odd numbers are at the start, all even at the end).</p>
|
|||
|
|
<p>If this slice is not partitioned, the returned result is unspecified and meaningless,
|
|||
|
|
as this method performs a kind of binary search.</p>
|
|||
|
|
<p>See also <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.binary_search" title="method slice::binary_search"><code>binary_search</code></a>, <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.binary_search_by" title="method slice::binary_search_by"><code>binary_search_by</code></a>, and <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.binary_search_by_key" title="method slice::binary_search_by_key"><code>binary_search_by_key</code></a>.</p>
|
|||
|
|
<h5 id="examples-103"><a href="#examples-103">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>v = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>];
|
|||
|
|
<span class="kw">let </span>i = v.partition_point(|<span class="kw-2">&</span>x| x < <span class="number">5</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(i, <span class="number">4</span>);
|
|||
|
|
<span class="macro">assert!</span>(v[..i].iter().all(|<span class="kw-2">&</span>x| x < <span class="number">5</span>));
|
|||
|
|
<span class="macro">assert!</span>(v[i..].iter().all(|<span class="kw-2">&</span>x| !(x < <span class="number">5</span>)));</code></pre></div>
|
|||
|
|
<p>If all elements of the slice match the predicate, including if the slice
|
|||
|
|
is empty, then the length of the slice will be returned:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>a = [<span class="number">2</span>, <span class="number">4</span>, <span class="number">8</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(a.partition_point(|x| x < <span class="kw-2">&</span><span class="number">100</span>), a.len());
|
|||
|
|
<span class="kw">let </span>a: [i32; <span class="number">0</span>] = [];
|
|||
|
|
<span class="macro">assert_eq!</span>(a.partition_point(|x| x < <span class="kw-2">&</span><span class="number">100</span>), <span class="number">0</span>);</code></pre></div>
|
|||
|
|
<p>If you want to insert an item to a sorted vector, while maintaining
|
|||
|
|
sort order:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>s = <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">8</span>, <span class="number">13</span>, <span class="number">21</span>, <span class="number">34</span>, <span class="number">55</span>];
|
|||
|
|
<span class="kw">let </span>num = <span class="number">42</span>;
|
|||
|
|
<span class="kw">let </span>idx = s.partition_point(|<span class="kw-2">&</span>x| x < num);
|
|||
|
|
s.insert(idx, num);
|
|||
|
|
<span class="macro">assert_eq!</span>(s, [<span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">8</span>, <span class="number">13</span>, <span class="number">21</span>, <span class="number">34</span>, <span class="number">42</span>, <span class="number">55</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.take" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4261">source</a><h4 class="code-header">pub fn <a href="#method.take" class="fn">take</a><R, 'a>(self: &mut &'a <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, range: R) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>><div class="where">where
|
|||
|
|
R: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/range/trait.OneSidedRange.html" title="trait core::ops::range::OneSidedRange">OneSidedRange</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_take</code>)</span></div></span></summary><div class="docblock"><p>Removes the subslice corresponding to the given range
|
|||
|
|
and returns a reference to it.</p>
|
|||
|
|
<p>Returns <code>None</code> and does not modify the slice if the given
|
|||
|
|
range is out of bounds.</p>
|
|||
|
|
<p>Note that this method only accepts one-sided ranges such as
|
|||
|
|
<code>2..</code> or <code>..6</code>, but not <code>2..6</code>.</p>
|
|||
|
|
<h5 id="examples-104"><a href="#examples-104">Examples</a></h5>
|
|||
|
|
<p>Taking the first three elements of a slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_take)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>first_three = slice.take(..<span class="number">3</span>).unwrap();
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, <span class="kw-2">&</span>[<span class="string">'d'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(first_three, <span class="kw-2">&</span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>]);</code></pre></div>
|
|||
|
|
<p>Taking the last two elements of a slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_take)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>tail = slice.take(<span class="number">2</span>..).unwrap();
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, <span class="kw-2">&</span>[<span class="string">'a'</span>, <span class="string">'b'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(tail, <span class="kw-2">&</span>[<span class="string">'c'</span>, <span class="string">'d'</span>]);</code></pre></div>
|
|||
|
|
<p>Getting <code>None</code> when <code>range</code> is out of bounds:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_take)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>];
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, slice.take(<span class="number">5</span>..));
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, slice.take(..<span class="number">5</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, slice.take(..=<span class="number">4</span>));
|
|||
|
|
<span class="kw">let </span>expected: <span class="kw-2">&</span>[char] = <span class="kw-2">&</span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(expected), slice.take(..<span class="number">4</span>));</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.take_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4330-4333">source</a><h4 class="code-header">pub fn <a href="#method.take_mut" class="fn">take_mut</a><R, 'a>(self: &mut &'a mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>, range: R) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>><div class="where">where
|
|||
|
|
R: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/range/trait.OneSidedRange.html" title="trait core::ops::range::OneSidedRange">OneSidedRange</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_take</code>)</span></div></span></summary><div class="docblock"><p>Removes the subslice corresponding to the given range
|
|||
|
|
and returns a mutable reference to it.</p>
|
|||
|
|
<p>Returns <code>None</code> and does not modify the slice if the given
|
|||
|
|
range is out of bounds.</p>
|
|||
|
|
<p>Note that this method only accepts one-sided ranges such as
|
|||
|
|
<code>2..</code> or <code>..6</code>, but not <code>2..6</code>.</p>
|
|||
|
|
<h5 id="examples-105"><a href="#examples-105">Examples</a></h5>
|
|||
|
|
<p>Taking the first three elements of a slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_take)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice: <span class="kw-2">&mut </span>[<span class="kw">_</span>] = <span class="kw-2">&mut </span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>first_three = slice.take_mut(..<span class="number">3</span>).unwrap();
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, <span class="kw-2">&mut </span>[<span class="string">'d'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(first_three, <span class="kw-2">&mut </span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>]);</code></pre></div>
|
|||
|
|
<p>Taking the last two elements of a slice:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_take)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice: <span class="kw-2">&mut </span>[<span class="kw">_</span>] = <span class="kw-2">&mut </span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>];
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>tail = slice.take_mut(<span class="number">2</span>..).unwrap();
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, <span class="kw-2">&mut </span>[<span class="string">'a'</span>, <span class="string">'b'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(tail, <span class="kw-2">&mut </span>[<span class="string">'c'</span>, <span class="string">'d'</span>]);</code></pre></div>
|
|||
|
|
<p>Getting <code>None</code> when <code>range</code> is out of bounds:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_take)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice: <span class="kw-2">&mut </span>[<span class="kw">_</span>] = <span class="kw-2">&mut </span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>];
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, slice.take_mut(<span class="number">5</span>..));
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, slice.take_mut(..<span class="number">5</span>));
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, slice.take_mut(..=<span class="number">4</span>));
|
|||
|
|
<span class="kw">let </span>expected: <span class="kw-2">&mut </span>[<span class="kw">_</span>] = <span class="kw-2">&mut </span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>, <span class="string">'d'</span>];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(expected), slice.take_mut(..<span class="number">4</span>));</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.take_first" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4369">source</a><h4 class="code-header">pub fn <a href="#method.take_first" class="fn">take_first</a><'a>(self: &mut &'a <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'a T</a>></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_take</code>)</span></div></span></summary><div class="docblock"><p>Removes the first element of the slice and returns a reference
|
|||
|
|
to it.</p>
|
|||
|
|
<p>Returns <code>None</code> if the slice is empty.</p>
|
|||
|
|
<h5 id="examples-106"><a href="#examples-106">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_take)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>];
|
|||
|
|
<span class="kw">let </span>first = slice.take_first().unwrap();
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, <span class="kw-2">&</span>[<span class="string">'b'</span>, <span class="string">'c'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(first, <span class="kw-2">&</span><span class="string">'a'</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.take_first_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4394">source</a><h4 class="code-header">pub fn <a href="#method.take_first_mut" class="fn">take_first_mut</a><'a>(self: &mut &'a mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'a mut T</a>></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_take</code>)</span></div></span></summary><div class="docblock"><p>Removes the first element of the slice and returns a mutable
|
|||
|
|
reference to it.</p>
|
|||
|
|
<p>Returns <code>None</code> if the slice is empty.</p>
|
|||
|
|
<h5 id="examples-107"><a href="#examples-107">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_take)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice: <span class="kw-2">&mut </span>[<span class="kw">_</span>] = <span class="kw-2">&mut </span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>];
|
|||
|
|
<span class="kw">let </span>first = slice.take_first_mut().unwrap();
|
|||
|
|
<span class="kw-2">*</span>first = <span class="string">'d'</span>;
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, <span class="kw-2">&</span>[<span class="string">'b'</span>, <span class="string">'c'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(first, <span class="kw-2">&</span><span class="string">'d'</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.take_last" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4418">source</a><h4 class="code-header">pub fn <a href="#method.take_last" class="fn">take_last</a><'a>(self: &mut &'a <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'a T</a>></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_take</code>)</span></div></span></summary><div class="docblock"><p>Removes the last element of the slice and returns a reference
|
|||
|
|
to it.</p>
|
|||
|
|
<p>Returns <code>None</code> if the slice is empty.</p>
|
|||
|
|
<h5 id="examples-108"><a href="#examples-108">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_take)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice: <span class="kw-2">&</span>[<span class="kw">_</span>] = <span class="kw-2">&</span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>];
|
|||
|
|
<span class="kw">let </span>last = slice.take_last().unwrap();
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, <span class="kw-2">&</span>[<span class="string">'a'</span>, <span class="string">'b'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(last, <span class="kw-2">&</span><span class="string">'c'</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.take_last_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4443">source</a><h4 class="code-header">pub fn <a href="#method.take_last_mut" class="fn">take_last_mut</a><'a>(self: &mut &'a mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'a mut T</a>></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_take</code>)</span></div></span></summary><div class="docblock"><p>Removes the last element of the slice and returns a mutable
|
|||
|
|
reference to it.</p>
|
|||
|
|
<p>Returns <code>None</code> if the slice is empty.</p>
|
|||
|
|
<h5 id="examples-109"><a href="#examples-109">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_take)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>slice: <span class="kw-2">&mut </span>[<span class="kw">_</span>] = <span class="kw-2">&mut </span>[<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>];
|
|||
|
|
<span class="kw">let </span>last = slice.take_last_mut().unwrap();
|
|||
|
|
<span class="kw-2">*</span>last = <span class="string">'d'</span>;
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(slice, <span class="kw-2">&</span>[<span class="string">'a'</span>, <span class="string">'b'</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>(last, <span class="kw-2">&</span><span class="string">'d'</span>);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_many_unchecked_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4477-4480">source</a><h4 class="code-header">pub unsafe fn <a href="#method.get_many_unchecked_mut" class="fn">get_many_unchecked_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(
|
|||
|
|
&mut self,
|
|||
|
|
indices: [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">N</a>]
|
|||
|
|
) -> [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">N</a>]</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>get_many_mut</code>)</span></div></span></summary><div class="docblock"><p>Returns mutable references to many indices at once, without doing any checks.</p>
|
|||
|
|
<p>For a safe alternative see <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.get_many_mut" title="method slice::get_many_mut"><code>get_many_mut</code></a>.</p>
|
|||
|
|
<h5 id="safety-11"><a href="#safety-11">Safety</a></h5>
|
|||
|
|
<p>Calling this method with overlapping or out-of-bounds indices is <em><a href="https://doc.rust-lang.org/reference/behavior-considered-undefined.html">undefined behavior</a></em>
|
|||
|
|
even if the resulting references are not used.</p>
|
|||
|
|
<h5 id="examples-110"><a href="#examples-110">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(get_many_mut)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>x = <span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>];
|
|||
|
|
|
|||
|
|
<span class="kw">unsafe </span>{
|
|||
|
|
<span class="kw">let </span>[a, b] = x.get_many_unchecked_mut([<span class="number">0</span>, <span class="number">2</span>]);
|
|||
|
|
<span class="kw-2">*</span>a <span class="kw-2">*</span>= <span class="number">10</span>;
|
|||
|
|
<span class="kw-2">*</span>b <span class="kw-2">*</span>= <span class="number">100</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(x, <span class="kw-2">&</span>[<span class="number">10</span>, <span class="number">2</span>, <span class="number">400</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_many_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4519-4522">source</a><h4 class="code-header">pub fn <a href="#method.get_many_mut" class="fn">get_many_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>>(
|
|||
|
|
&mut self,
|
|||
|
|
indices: [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">N</a>]
|
|||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">N</a>], <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/slice/struct.GetManyMutError.html" title="struct core::slice::GetManyMutError">GetManyMutError</a><N>></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>get_many_mut</code>)</span></div></span></summary><div class="docblock"><p>Returns mutable references to many indices at once.</p>
|
|||
|
|
<p>Returns an error if any index is out-of-bounds, or if the same index was
|
|||
|
|
passed more than once.</p>
|
|||
|
|
<h5 id="examples-111"><a href="#examples-111">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(get_many_mut)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">let </span>v = <span class="kw-2">&mut </span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
|
|||
|
|
<span class="kw">if let </span><span class="prelude-val">Ok</span>([a, b]) = v.get_many_mut([<span class="number">0</span>, <span class="number">2</span>]) {
|
|||
|
|
<span class="kw-2">*</span>a = <span class="number">413</span>;
|
|||
|
|
<span class="kw-2">*</span>b = <span class="number">612</span>;
|
|||
|
|
}
|
|||
|
|
<span class="macro">assert_eq!</span>(v, <span class="kw-2">&</span>[<span class="number">413</span>, <span class="number">2</span>, <span class="number">612</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.sort_floats" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4637">source</a><h4 class="code-header">pub fn <a href="#method.sort_floats" class="fn">sort_floats</a>(&mut self)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>sort_floats</code>)</span></div></span></summary><div class="docblock"><p>Sorts the slice of floats.</p>
|
|||
|
|
<p>This sort is in-place (i.e. does not allocate), <em>O</em>(<em>n</em> * log(<em>n</em>)) worst-case, and uses
|
|||
|
|
the ordering defined by <a href="https://doc.rust-lang.org/1.76.0/core/primitive.f32.html#method.total_cmp" title="method f32::total_cmp"><code>f32::total_cmp</code></a>.</p>
|
|||
|
|
<h5 id="current-implementation-6"><a href="#current-implementation-6">Current implementation</a></h5>
|
|||
|
|
<p>This uses the same sorting algorithm as <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_unstable_by" title="method slice::sort_unstable_by"><code>sort_unstable_by</code></a>.</p>
|
|||
|
|
<h5 id="examples-112"><a href="#examples-112">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(sort_floats)]
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">2.6</span>, -<span class="number">5e-8</span>, f32::NAN, <span class="number">8.29</span>, f32::INFINITY, -<span class="number">1.0</span>, <span class="number">0.0</span>, -f32::INFINITY, -<span class="number">0.0</span>];
|
|||
|
|
|
|||
|
|
v.sort_floats();
|
|||
|
|
<span class="kw">let </span>sorted = [-f32::INFINITY, -<span class="number">1.0</span>, -<span class="number">5e-8</span>, -<span class="number">0.0</span>, <span class="number">0.0</span>, <span class="number">2.6</span>, <span class="number">8.29</span>, f32::INFINITY, f32::NAN];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>v[..<span class="number">8</span>], <span class="kw-2">&</span>sorted[..<span class="number">8</span>]);
|
|||
|
|
<span class="macro">assert!</span>(v[<span class="number">8</span>].is_nan());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.flatten" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4562">source</a><h4 class="code-header">pub fn <a href="#method.flatten" class="fn">flatten</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_flatten</code>)</span></div></span></summary><div class="docblock"><p>Takes a <code>&[[T; N]]</code>, and flattens it to a <code>&[T]</code>.</p>
|
|||
|
|
<h5 id="panics-35"><a href="#panics-35">Panics</a></h5>
|
|||
|
|
<p>This panics if the length of the resulting slice would overflow a <code>usize</code>.</p>
|
|||
|
|
<p>This is only possible when flattening a slice of arrays of zero-sized
|
|||
|
|
types, and thus tends to be irrelevant in practice. If
|
|||
|
|
<code>size_of::<T>() > 0</code>, this will never panic.</p>
|
|||
|
|
<h5 id="examples-113"><a href="#examples-113">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_flatten)]
|
|||
|
|
|
|||
|
|
</span><span class="macro">assert_eq!</span>([[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>], [<span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]].flatten(), <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]);
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq!</span>(
|
|||
|
|
[[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>], [<span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>]].flatten(),
|
|||
|
|
[[<span class="number">1</span>, <span class="number">2</span>], [<span class="number">3</span>, <span class="number">4</span>], [<span class="number">5</span>, <span class="number">6</span>]].flatten(),
|
|||
|
|
);
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>slice_of_empty_arrays: <span class="kw-2">&</span>[[i32; <span class="number">0</span>]] = <span class="kw-2">&</span>[[], [], [], [], []];
|
|||
|
|
<span class="macro">assert!</span>(slice_of_empty_arrays.flatten().is_empty());
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>empty_slice_of_arrays: <span class="kw-2">&</span>[[u32; <span class="number">10</span>]] = <span class="kw-2">&</span>[];
|
|||
|
|
<span class="macro">assert!</span>(empty_slice_of_arrays.flatten().is_empty());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.flatten_mut" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4600">source</a><h4 class="code-header">pub fn <a href="#method.flatten_mut" class="fn">flatten_mut</a>(&mut self) -> &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>slice_flatten</code>)</span></div></span></summary><div class="docblock"><p>Takes a <code>&mut [[T; N]]</code>, and flattens it to a <code>&mut [T]</code>.</p>
|
|||
|
|
<h5 id="panics-36"><a href="#panics-36">Panics</a></h5>
|
|||
|
|
<p>This panics if the length of the resulting slice would overflow a <code>usize</code>.</p>
|
|||
|
|
<p>This is only possible when flattening a slice of arrays of zero-sized
|
|||
|
|
types, and thus tends to be irrelevant in practice. If
|
|||
|
|
<code>size_of::<T>() > 0</code>, this will never panic.</p>
|
|||
|
|
<h5 id="examples-114"><a href="#examples-114">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(slice_flatten)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">fn </span>add_5_to_all(slice: <span class="kw-2">&mut </span>[i32]) {
|
|||
|
|
<span class="kw">for </span>i <span class="kw">in </span>slice {
|
|||
|
|
<span class="kw-2">*</span>i += <span class="number">5</span>;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>array = [[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>], [<span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>], [<span class="number">7</span>, <span class="number">8</span>, <span class="number">9</span>]];
|
|||
|
|
add_5_to_all(array.flatten_mut());
|
|||
|
|
<span class="macro">assert_eq!</span>(array, [[<span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>], [<span class="number">9</span>, <span class="number">10</span>, <span class="number">11</span>], [<span class="number">12</span>, <span class="number">13</span>, <span class="number">14</span>]]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.sort_floats-1" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/slice/mod.rs.html#4666">source</a><h4 class="code-header">pub fn <a href="#method.sort_floats-1" class="fn">sort_floats</a>(&mut self)</h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>sort_floats</code>)</span></div></span></summary><div class="docblock"><p>Sorts the slice of floats.</p>
|
|||
|
|
<p>This sort is in-place (i.e. does not allocate), <em>O</em>(<em>n</em> * log(<em>n</em>)) worst-case, and uses
|
|||
|
|
the ordering defined by <a href="https://doc.rust-lang.org/1.76.0/core/primitive.f64.html#method.total_cmp" title="method f64::total_cmp"><code>f64::total_cmp</code></a>.</p>
|
|||
|
|
<h5 id="current-implementation-7"><a href="#current-implementation-7">Current implementation</a></h5>
|
|||
|
|
<p>This uses the same sorting algorithm as <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_unstable_by" title="method slice::sort_unstable_by"><code>sort_unstable_by</code></a>.</p>
|
|||
|
|
<h5 id="examples-115"><a href="#examples-115">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(sort_floats)]
|
|||
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">2.6</span>, -<span class="number">5e-8</span>, f64::NAN, <span class="number">8.29</span>, f64::INFINITY, -<span class="number">1.0</span>, <span class="number">0.0</span>, -f64::INFINITY, -<span class="number">0.0</span>];
|
|||
|
|
|
|||
|
|
v.sort_floats();
|
|||
|
|
<span class="kw">let </span>sorted = [-f64::INFINITY, -<span class="number">1.0</span>, -<span class="number">5e-8</span>, -<span class="number">0.0</span>, <span class="number">0.0</span>, <span class="number">2.6</span>, <span class="number">8.29</span>, f64::INFINITY, f64::NAN];
|
|||
|
|
<span class="macro">assert_eq!</span>(<span class="kw-2">&</span>v[..<span class="number">8</span>], <span class="kw-2">&</span>sorted[..<span class="number">8</span>]);
|
|||
|
|
<span class="macro">assert!</span>(v[<span class="number">8</span>].is_nan());</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.sort" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#207-209">source</a></span><h4 class="code-header">pub fn <a href="#method.sort" class="fn">sort</a>(&mut self)<div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Sorts the slice.</p>
|
|||
|
|
<p>This sort is stable (i.e., does not reorder equal elements) and <em>O</em>(<em>n</em> * log(<em>n</em>)) worst-case.</p>
|
|||
|
|
<p>When applicable, unstable sorting is preferred because it is generally faster than stable
|
|||
|
|
sorting and it doesn’t allocate auxiliary memory.
|
|||
|
|
See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_unstable" title="method slice::sort_unstable"><code>sort_unstable</code></a>.</p>
|
|||
|
|
<h5 id="current-implementation-8"><a href="#current-implementation-8">Current implementation</a></h5>
|
|||
|
|
<p>The current algorithm is an adaptive, iterative merge sort inspired by
|
|||
|
|
<a href="https://en.wikipedia.org/wiki/Timsort">timsort</a>.
|
|||
|
|
It is designed to be very fast in cases where the slice is nearly sorted, or consists of
|
|||
|
|
two or more sorted sequences concatenated one after another.</p>
|
|||
|
|
<p>Also, it allocates temporary storage half the size of <code>self</code>, but for short slices a
|
|||
|
|
non-allocating insertion sort is used instead.</p>
|
|||
|
|
<h5 id="examples-116"><a href="#examples-116">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [-<span class="number">5</span>, <span class="number">4</span>, <span class="number">1</span>, -<span class="number">3</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
v.sort();
|
|||
|
|
<span class="macro">assert!</span>(v == [-<span class="number">5</span>, -<span class="number">3</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.sort_by" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#263-265">source</a></span><h4 class="code-header">pub fn <a href="#method.sort_by" class="fn">sort_by</a><F>(&mut self, compare: F)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>,</div></h4></section></summary><div class="docblock"><p>Sorts the slice with a comparator function.</p>
|
|||
|
|
<p>This sort is stable (i.e., does not reorder equal elements) and <em>O</em>(<em>n</em> * log(<em>n</em>)) worst-case.</p>
|
|||
|
|
<p>The comparator function must define a total ordering for the elements in the slice. If
|
|||
|
|
the ordering is not total, the order of the elements is unspecified. An order is a
|
|||
|
|
total order if it is (for all <code>a</code>, <code>b</code> and <code>c</code>):</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>total and antisymmetric: exactly one of <code>a < b</code>, <code>a == b</code> or <code>a > b</code> is true, and</li>
|
|||
|
|
<li>transitive, <code>a < b</code> and <code>b < c</code> implies <code>a < c</code>. The same must hold for both <code>==</code> and <code>></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>For example, while <a href="https://doc.rust-lang.org/1.76.0/core/primitive.f64.html" title="primitive f64"><code>f64</code></a> doesn’t implement <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord"><code>Ord</code></a> because <code>NaN != NaN</code>, we can use
|
|||
|
|
<code>partial_cmp</code> as our sort function when we know the slice doesn’t contain a <code>NaN</code>.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>floats = [<span class="number">5f64</span>, <span class="number">4.0</span>, <span class="number">1.0</span>, <span class="number">3.0</span>, <span class="number">2.0</span>];
|
|||
|
|
floats.sort_by(|a, b| a.partial_cmp(b).unwrap());
|
|||
|
|
<span class="macro">assert_eq!</span>(floats, [<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>, <span class="number">4.0</span>, <span class="number">5.0</span>]);</code></pre></div>
|
|||
|
|
<p>When applicable, unstable sorting is preferred because it is generally faster than stable
|
|||
|
|
sorting and it doesn’t allocate auxiliary memory.
|
|||
|
|
See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_unstable_by" title="method slice::sort_unstable_by"><code>sort_unstable_by</code></a>.</p>
|
|||
|
|
<h5 id="current-implementation-9"><a href="#current-implementation-9">Current implementation</a></h5>
|
|||
|
|
<p>The current algorithm is an adaptive, iterative merge sort inspired by
|
|||
|
|
<a href="https://en.wikipedia.org/wiki/Timsort">timsort</a>.
|
|||
|
|
It is designed to be very fast in cases where the slice is nearly sorted, or consists of
|
|||
|
|
two or more sorted sequences concatenated one after another.</p>
|
|||
|
|
<p>Also, it allocates temporary storage half the size of <code>self</code>, but for short slices a
|
|||
|
|
non-allocating insertion sort is used instead.</p>
|
|||
|
|
<h5 id="examples-117"><a href="#examples-117">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [<span class="number">5</span>, <span class="number">4</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">2</span>];
|
|||
|
|
v.sort_by(|a, b| a.cmp(b));
|
|||
|
|
<span class="macro">assert!</span>(v == [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);
|
|||
|
|
|
|||
|
|
<span class="comment">// reverse sorting
|
|||
|
|
</span>v.sort_by(|a, b| b.cmp(a));
|
|||
|
|
<span class="macro">assert!</span>(v == [<span class="number">5</span>, <span class="number">4</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">1</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.sort_by_key" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.7.0">1.7.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#305-308">source</a></span><h4 class="code-header">pub fn <a href="#method.sort_by_key" class="fn">sort_by_key</a><K, F>(&mut self, f: F)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> K,
|
|||
|
|
K: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Sorts the slice with a key extraction function.</p>
|
|||
|
|
<p>This sort is stable (i.e., does not reorder equal elements) and <em>O</em>(<em>m</em> * <em>n</em> * log(<em>n</em>))
|
|||
|
|
worst-case, where the key function is <em>O</em>(<em>m</em>).</p>
|
|||
|
|
<p>For expensive key functions (e.g. functions that are not simple property accesses or
|
|||
|
|
basic operations), <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_by_cached_key" title="method slice::sort_by_cached_key"><code>sort_by_cached_key</code></a> is likely to be
|
|||
|
|
significantly faster, as it does not recompute element keys.</p>
|
|||
|
|
<p>When applicable, unstable sorting is preferred because it is generally faster than stable
|
|||
|
|
sorting and it doesn’t allocate auxiliary memory.
|
|||
|
|
See <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_unstable_by_key" title="method slice::sort_unstable_by_key"><code>sort_unstable_by_key</code></a>.</p>
|
|||
|
|
<h5 id="current-implementation-10"><a href="#current-implementation-10">Current implementation</a></h5>
|
|||
|
|
<p>The current algorithm is an adaptive, iterative merge sort inspired by
|
|||
|
|
<a href="https://en.wikipedia.org/wiki/Timsort">timsort</a>.
|
|||
|
|
It is designed to be very fast in cases where the slice is nearly sorted, or consists of
|
|||
|
|
two or more sorted sequences concatenated one after another.</p>
|
|||
|
|
<p>Also, it allocates temporary storage half the size of <code>self</code>, but for short slices a
|
|||
|
|
non-allocating insertion sort is used instead.</p>
|
|||
|
|
<h5 id="examples-118"><a href="#examples-118">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [-<span class="number">5i32</span>, <span class="number">4</span>, <span class="number">1</span>, -<span class="number">3</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
v.sort_by_key(|k| k.abs());
|
|||
|
|
<span class="macro">assert!</span>(v == [<span class="number">1</span>, <span class="number">2</span>, -<span class="number">3</span>, <span class="number">4</span>, -<span class="number">5</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.sort_by_cached_key" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.34.0">1.34.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#352-355">source</a></span><h4 class="code-header">pub fn <a href="#method.sort_by_cached_key" class="fn">sort_by_cached_key</a><K, F>(&mut self, f: F)<div class="where">where
|
|||
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a>) -> K,
|
|||
|
|
K: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h4></section></summary><div class="docblock"><p>Sorts the slice with a key extraction function.</p>
|
|||
|
|
<p>During sorting, the key function is called at most once per element, by using
|
|||
|
|
temporary storage to remember the results of key evaluation.
|
|||
|
|
The order of calls to the key function is unspecified and may change in future versions
|
|||
|
|
of the standard library.</p>
|
|||
|
|
<p>This sort is stable (i.e., does not reorder equal elements) and <em>O</em>(<em>m</em> * <em>n</em> + <em>n</em> * log(<em>n</em>))
|
|||
|
|
worst-case, where the key function is <em>O</em>(<em>m</em>).</p>
|
|||
|
|
<p>For simple key functions (e.g., functions that are property accesses or
|
|||
|
|
basic operations), <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.sort_by_key" title="method slice::sort_by_key"><code>sort_by_key</code></a> is likely to be
|
|||
|
|
faster.</p>
|
|||
|
|
<h5 id="current-implementation-11"><a href="#current-implementation-11">Current implementation</a></h5>
|
|||
|
|
<p>The current algorithm is based on <a href="https://github.com/orlp/pdqsort">pattern-defeating quicksort</a> by Orson Peters,
|
|||
|
|
which combines the fast average case of randomized quicksort with the fast worst case of
|
|||
|
|
heapsort, while achieving linear time on slices with certain patterns. It uses some
|
|||
|
|
randomization to avoid degenerate cases, but with a fixed seed to always provide
|
|||
|
|
deterministic behavior.</p>
|
|||
|
|
<p>In the worst case, the algorithm allocates temporary storage in a <code>Vec<(K, usize)></code> the
|
|||
|
|
length of the slice.</p>
|
|||
|
|
<h5 id="examples-119"><a href="#examples-119">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>v = [-<span class="number">5i32</span>, <span class="number">4</span>, <span class="number">32</span>, -<span class="number">3</span>, <span class="number">2</span>];
|
|||
|
|
|
|||
|
|
v.sort_by_cached_key(|k| k.to_string());
|
|||
|
|
<span class="macro">assert!</span>(v == [-<span class="number">3</span>, -<span class="number">5</span>, <span class="number">2</span>, <span class="number">32</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.to_vec" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#412-414">source</a></span><h4 class="code-header">pub fn <a href="#method.to_vec" class="fn">to_vec</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T><div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section></summary><div class="docblock"><p>Copies <code>self</code> into a new <code>Vec</code>.</p>
|
|||
|
|
<h5 id="examples-120"><a href="#examples-120">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>s = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="kw">let </span>x = s.to_vec();
|
|||
|
|
<span class="comment">// Here, `s` and `x` can be modified independently.</span></code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.to_vec_in" class="method"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#436-438">source</a><h4 class="code-header">pub fn <a href="#method.to_vec_in" class="fn">to_vec_in</a><A>(&self, alloc: A) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T, A><div class="where">where
|
|||
|
|
A: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/alloc/trait.Allocator.html" title="trait core::alloc::Allocator">Allocator</a>,
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h4></section><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>allocator_api</code>)</span></div></span></summary><div class="docblock"><p>Copies <code>self</code> into a new <code>Vec</code> with an allocator.</p>
|
|||
|
|
<h5 id="examples-121"><a href="#examples-121">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#![feature(allocator_api)]
|
|||
|
|
|
|||
|
|
</span><span class="kw">use </span>std::alloc::System;
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>s = [<span class="number">10</span>, <span class="number">40</span>, <span class="number">30</span>];
|
|||
|
|
<span class="kw">let </span>x = s.to_vec_in(System);
|
|||
|
|
<span class="comment">// Here, `s` and `x` can be modified independently.</span></code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.repeat" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.40.0">1.40.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#489-491">source</a></span><h4 class="code-header">pub fn <a href="#method.repeat" class="fn">repeat</a>(&self, n: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T><div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,</div></h4></section></summary><div class="docblock"><p>Creates a vector by copying a slice <code>n</code> times.</p>
|
|||
|
|
<h5 id="panics-37"><a href="#panics-37">Panics</a></h5>
|
|||
|
|
<p>This function will panic if the capacity would overflow.</p>
|
|||
|
|
<h5 id="examples-122"><a href="#examples-122">Examples</a></h5>
|
|||
|
|
<p>Basic usage:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>([<span class="number">1</span>, <span class="number">2</span>].repeat(<span class="number">3</span>), <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">1</span>, <span class="number">2</span>]);</code></pre></div>
|
|||
|
|
<p>A panic upon overflow:</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap should_panic"><a href="#" class="tooltip" title="This example panics">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="comment">// this will panic at runtime
|
|||
|
|
</span><span class="string">b"0123456789abcdef"</span>.repeat(usize::MAX);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.concat" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#557-559">source</a></span><h4 class="code-header">pub fn <a href="#method.concat" class="fn">concat</a><Item>(&self) -> <<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a> as <a class="trait" href="https://doc.rust-lang.org/1.76.0/alloc/slice/trait.Concat.html" title="trait alloc::slice::Concat">Concat</a><Item>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/alloc/slice/trait.Concat.html#associatedtype.Output" title="type alloc::slice::Concat::Output">Output</a><div class="where">where
|
|||
|
|
<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/alloc/slice/trait.Concat.html" title="trait alloc::slice::Concat">Concat</a><Item>,
|
|||
|
|
Item: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Flattens a slice of <code>T</code> into a single value <code>Self::Output</code>.</p>
|
|||
|
|
<h5 id="examples-123"><a href="#examples-123">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>([<span class="string">"hello"</span>, <span class="string">"world"</span>].concat(), <span class="string">"helloworld"</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>([[<span class="number">1</span>, <span class="number">2</span>], [<span class="number">3</span>, <span class="number">4</span>]].concat(), [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.join" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#576-578">source</a></span><h4 class="code-header">pub fn <a href="#method.join" class="fn">join</a><Separator>(
|
|||
|
|
&self,
|
|||
|
|
sep: Separator
|
|||
|
|
) -> <<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a> as <a class="trait" href="https://doc.rust-lang.org/1.76.0/alloc/slice/trait.Join.html" title="trait alloc::slice::Join">Join</a><Separator>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/alloc/slice/trait.Join.html#associatedtype.Output" title="type alloc::slice::Join::Output">Output</a><div class="where">where
|
|||
|
|
<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/alloc/slice/trait.Join.html" title="trait alloc::slice::Join">Join</a><Separator>,</div></h4></section></summary><div class="docblock"><p>Flattens a slice of <code>T</code> into a single value <code>Self::Output</code>, placing a
|
|||
|
|
given separator between each.</p>
|
|||
|
|
<h5 id="examples-124"><a href="#examples-124">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>([<span class="string">"hello"</span>, <span class="string">"world"</span>].join(<span class="string">" "</span>), <span class="string">"hello world"</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>([[<span class="number">1</span>, <span class="number">2</span>], [<span class="number">3</span>, <span class="number">4</span>]].join(<span class="kw-2">&</span><span class="number">0</span>), [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">4</span>]);
|
|||
|
|
<span class="macro">assert_eq!</span>([[<span class="number">1</span>, <span class="number">2</span>], [<span class="number">3</span>, <span class="number">4</span>]].join(<span class="kw-2">&</span>[<span class="number">0</span>, <span class="number">0</span>][..]), [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.connect" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#596-598">source</a></span><h4 class="code-header">pub fn <a href="#method.connect" class="fn">connect</a><Separator>(
|
|||
|
|
&self,
|
|||
|
|
sep: Separator
|
|||
|
|
) -> <<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a> as <a class="trait" href="https://doc.rust-lang.org/1.76.0/alloc/slice/trait.Join.html" title="trait alloc::slice::Join">Join</a><Separator>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/alloc/slice/trait.Join.html#associatedtype.Output" title="type alloc::slice::Join::Output">Output</a><div class="where">where
|
|||
|
|
<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/alloc/slice/trait.Join.html" title="trait alloc::slice::Join">Join</a><Separator>,</div></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 1.3.0: renamed to join</span></div></span></summary><div class="docblock"><p>Flattens a slice of <code>T</code> into a single value <code>Self::Output</code>, placing a
|
|||
|
|
given separator between each.</p>
|
|||
|
|
<h5 id="examples-125"><a href="#examples-125">Examples</a></h5>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">assert_eq!</span>([<span class="string">"hello"</span>, <span class="string">"world"</span>].connect(<span class="string">" "</span>), <span class="string">"hello world"</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>([[<span class="number">1</span>, <span class="number">2</span>], [<span class="number">3</span>, <span class="number">4</span>]].connect(<span class="kw-2">&</span><span class="number">0</span>), [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">4</span>]);</code></pre></div>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.to_ascii_uppercase" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#621">source</a></span><h4 class="code-header">pub fn <a href="#method.to_ascii_uppercase" class="fn">to_ascii_uppercase</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>></h4></section></summary><div class="docblock"><p>Returns a vector containing a copy of this slice where each byte
|
|||
|
|
is mapped to its ASCII upper case equivalent.</p>
|
|||
|
|
<p>ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’,
|
|||
|
|
but non-ASCII letters are unchanged.</p>
|
|||
|
|
<p>To uppercase the value in-place, use <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.make_ascii_uppercase" title="method slice::make_ascii_uppercase"><code>make_ascii_uppercase</code></a>.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.to_ascii_lowercase" class="method"><span class="rightside"><span class="since" title="Stable since Rust version 1.23.0">1.23.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/slice.rs.html#642">source</a></span><h4 class="code-header">pub fn <a href="#method.to_ascii_lowercase" class="fn">to_ascii_lowercase</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>></h4></section></summary><div class="docblock"><p>Returns a vector containing a copy of this slice where each byte
|
|||
|
|
is mapped to its ASCII lower case equivalent.</p>
|
|||
|
|
<p>ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’,
|
|||
|
|
but non-ASCII letters are unchanged.</p>
|
|||
|
|
<p>To lowercase the value in-place, use <a href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html#method.make_ascii_lowercase" title="method slice::make_ascii_lowercase"><code>make_ascii_lowercase</code></a>.</p>
|
|||
|
|
</div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-AsMut%3C%5B%3CA+as+Array%3E::Item%5D%3E-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#1870-1875">source</a><a href="#impl-AsMut%3C%5B%3CA+as+Array%3E::Item%5D%3E-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><[<A as <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>>::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_mut" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#1872-1874">source</a><a href="#method.as_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsMut.html#tymethod.as_mut" class="fn">as_mut</a>(&mut self) -> &mut [A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]</h4></section></summary><div class='docblock'>Converts this type into a mutable reference of the (usually inferred) input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AsRef%3C%5B%3CA+as+Array%3E::Item%5D%3E-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#1863-1868">source</a><a href="#impl-AsRef%3C%5B%3CA+as+Array%3E::Item%5D%3E-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[<A as <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>>::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_ref" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#1865-1867">source</a><a href="#method.as_ref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.AsRef.html#tymethod.as_ref" class="fn">as_ref</a>(&self) -> &[A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]</h4></section></summary><div class='docblock'>Converts this type into a shared reference of the (usually inferred) input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Borrow%3C%5B%3CA+as+Array%3E::Item%5D%3E-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#1877-1882">source</a><a href="#impl-Borrow%3C%5B%3CA+as+Array%3E::Item%5D%3E-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><[<A as <a class="trait" href="trait.Array.html" title="trait smal
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2134-2136">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2138-2151">source</a><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&Self</a>)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2085-2092">source</a><a href="#impl-Debug-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2089-2091">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2094-2099">source</a><a href="#impl-Default-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2096-2098">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.76.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Deref-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#1842-1851">source</a><a href="#impl-Deref-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl"><a href="#associatedtype.Target" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/ops/deref/trait.Deref.html#associatedtype.Target" class="associatedtype">Target</a> = [<A as <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>>::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]</h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#1845-1850">source</a><a href="#method.deref" class="anchor"><EFBFBD>
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2001-2003">source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(slice: &'a [A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]) -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CA%3E-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2019-2024">source</a><a href="#impl-From%3CA%3E-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><A> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2021-2023">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(array: A) -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CVec%3C%3CA+as+Array%3E::Item%3E%3E-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2012-2017">source</a><a href="#impl-From%3CVec%3C%3CA+as+Array%3E::Item%3E%3E-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<A as <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>>::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>>> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-2" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2014-2016">source</a><a href="#method.from-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(vec: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>>) -> <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallV
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.hash" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2190-2192">source</a><a href="#method.hash" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/hash/trait.Hash.html#tymethod.hash" class="fn">hash</a><H: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, state: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut H</a>)</h4></section></summary><div class='docblock'>Feeds this value into the given <a href="https://doc.rust-lang.org/1.76.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.76.0/core/hash/trait.Hash.html#tymethod.hash">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.hash_slice" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/hash/mod.rs.html#238-240">source</a></span><a href="#method.hash_slice" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/hash/trait.Hash.html#method.hash_slice" class="fn">hash_slice</a><H>(data: &<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut H</a>)<div class="where">where
|
|||
|
|
H: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/1.76.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.76.0/core/hash/trait.Hash.html#method.hash_slice">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Index%3CI%3E-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2026-2032">source</a><a href="#impl-Index%3CI%3E-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>, I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><[A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><I> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/ops/index/trait.Index.html#associatedtype.Output" class="associatedtype">Output</a> = <I as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><[<A as <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>>::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html#associatedtype.Output" title="type core::slice::index::SliceIndex::Output">Output</a></h4></section></summary><div class='docblock'>The returned type after indexing.</div></details><details class="toggle method-toggle" open><summary><section id="method.index" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2029-2031">source</a><a href="#method.index" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/ops/index/trait.Index.html#tymethod.index" class="fn">index</a>(&self, index: I) -> &I::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html#associatedtype.Output" title="type core::slice::index::SliceIndex::Output">Output</a></h4></section></summary><div class='docblock'>Performs the indexing (<code>container[index]</code>) operation. <a href="https://doc.rust-lang.org/1.76.0/core/ops/index/trait.Index.html#tymethod.index">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IndexMut%3CI%3E-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2034-2038">source</a><a href="#impl-IndexMut%3CI%3E-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>, I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/slice/index/trait.SliceIndex.html" title="trait core::slice::index::SliceIndex">SliceIndex</a><[A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>]>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/index/trait.IndexMut.html" title="
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.cmp" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2181-2183">source</a><a href="#method.cmp" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html#tymethod.cmp" class="fn">cmp</a>(&self, other: &<a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></h4></section></summary><div class='docblock'>This method returns an <a href="https://doc.rust-lang.org/1.76.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering"><code>Ordering</code></a> between <code>self</code> and <code>other</code>. <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html#tymethod.cmp">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.max" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.21.0">1.21.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/cmp.rs.html#829-831">source</a></span><a href="#method.max" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html#method.max" class="fn">max</a>(self, other: Self) -> Self<div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Compares and returns the maximum of two values. <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html#method.max">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.min" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.21.0">1.21.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/cmp.rs.html#849-851">source</a></span><a href="#method.min" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html#method.min" class="fn">min</a>(self, other: Self) -> Self<div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Compares and returns the minimum of two values. <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html#method.min">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clamp" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.50.0">1.50.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/cmp.rs.html#874-877">source</a></span><a href="#method.clamp" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html#method.clamp" class="fn">clamp</a>(self, min: Self, max: Self) -> Self<div class="where">where
|
|||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>,</div></h4></section></summary><div class='docblock'>Restrict a value to a certain interval. <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html#method.clamp">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CSmallVec%3CB%3E%3E-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2154-2162">source</a><a href="#impl-PartialEq%3CSmallVec%3CB%3E%3E-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>, B: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><B>> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><B::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2159-2161">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&self, other: &<a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><B>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
|||
|
|
by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/cmp.rs.html#242">source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
|
|||
|
|
sufficient, and should not be overridden without very good reason.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialOrd-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2166-2174">source</a><a href="#impl-PartialOrd-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.partial_cmp" class="method trait-impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2171-2173">source</a><a href="#method.partial_cmp" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp" class="fn">partial_cmp</a>(&self, other: &<a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></h4></section></summary><div class='docblock'>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.lt" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/cmp.rs.html#1125">source</a></span><a href="#method.lt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html#method.lt" class="fn">lt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.le" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/cmp.rs.html#1142">source</a></span><a href="#method.le" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html#method.le" class="fn">le</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code>
|
|||
|
|
operator. <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html#method.le">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.gt" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/cmp.rs.html#1158">source</a></span><a href="#method.gt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html#method.gt" class="fn">gt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.ge" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/core/cmp.rs.html#1175">source</a></span><a href="#method.ge" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html#method.ge" class="fn">ge</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code>
|
|||
|
|
operator. <a href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></div></details></div></details><section id="impl-Eq-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2164">source</a><a href="#impl-Eq-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,</div></h3></section><section id="impl-Send-for-SmallVec%3CA%3E" class="impl"><a class="src rightside" href="../src/smallvec/lib.rs.html#2195">source</a><a href="#impl-Send-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-SmallVec%3CA%3E" class="impl"><a href="#impl-RefUnwindSafe-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
|
|||
|
|
<A as <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>>::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Sync-for-SmallVec%3CA%3E" class="impl"><a href="#impl-Sync-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-SmallVec%3CA%3E" class="impl"><a href="#impl-Unpin-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-SmallVec%3CA%3E" class="impl"><a href="#impl-UnwindSafe-for-SmallVec%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<A> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.SmallVec.html" title="struct smallvec::SmallVec">SmallVec</a><A><div class="where">where
|
|||
|
|
A: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,
|
|||
|
|
<A as <a class="trait" href="trait.Array.html" title="trait smallvec::Array">Array</a>>::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type smallvec::Array::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|||
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.76.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.76.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#763">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-3" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#766">source</a><a href="#method.from-3" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#747-749">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#756">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|||
|
|
<p>That is, this conversion is whatever the implementation of
|
|||
|
|
<code><a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/alloc/borrow.rs.html#83-85">source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.76.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
|||
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.76.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.76.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#803-805">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#810">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#788-790">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.76.0/src/core/convert/mod.rs.html#795">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div><script type="text/json" id="notable-traits-data">{"Drain<'_, A>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.Drain.html\" title=\"struct smallvec::Drain\">Drain</a><'a, T></code></h3><pre><code><div class=\"where\">impl<'a, T: 'a + <a class=\"trait\" href=\"trait.Array.html\" title=\"trait smallvec::Array\">Array</a>> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.Drain.html\" title=\"struct smallvec::Drain\">Drain</a><'a, T></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = T::<a class=\"associatedtype\" href=\"trait.Array.html#associatedtype.Item\" title=\"type smallvec::Array::Item\">Item</a>;</div>"}</script></section></div></main></body></html>
|