difftastic/rustdoc/allocator_api2/trait.SliceExt.html

43 lines
13 KiB
HTML

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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="Slice methods that use `Box` and `Vec` from this crate."><title>SliceExt in allocator_api2 - 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="allocator_api2" 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 trait"><!--[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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../allocator_api2/index.html">allocator_api2</a><span class="version">0.2.16</span></h2></div><h2 class="location"><a href="#">SliceExt</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.repeat">repeat</a></li><li><a href="#tymethod.to_vec_in">to_vec_in</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.to_vec">to_vec</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-SliceExt%3CT%3E-for-%5BT%5D">[T]</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate allocator_api2</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../allocator_api2/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>Trait <a href="index.html">allocator_api2</a>::<wbr><a class="trait" href="#">SliceExt</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/allocator_api2/stable/slice.rs.html#7-67">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait SliceExt&lt;T&gt; {
// Required methods
fn <a href="#tymethod.to_vec_in" class="fn">to_vec_in</a>&lt;A: <a class="trait" href="alloc/trait.Allocator.html" title="trait allocator_api2::alloc::Allocator">Allocator</a>&gt;(&amp;self, alloc: A) -&gt; <a class="struct" href="vec/struct.Vec.html" title="struct allocator_api2::vec::Vec">Vec</a>&lt;T, A&gt;
<span 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></span>;
<span class="item-spacer"></span> fn <a href="#tymethod.repeat" class="fn">repeat</a>(&amp;self, n: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="vec/struct.Vec.html" title="struct allocator_api2::vec::Vec">Vec</a>&lt;T, <a class="struct" href="alloc/struct.Global.html" title="struct allocator_api2::alloc::Global">Global</a>&gt;
<span 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></span>;
// Provided method
fn <a href="#method.to_vec" class="fn">to_vec</a>(&amp;self) -&gt; <a class="struct" href="vec/struct.Vec.html" title="struct allocator_api2::vec::Vec">Vec</a>&lt;T, <a class="struct" href="alloc/struct.Global.html" title="struct allocator_api2::alloc::Global">Global</a>&gt;
<span 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></span> { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Slice methods that use <code>Box</code> and <code>Vec</code> from this crate.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.to_vec_in" class="method"><a class="src rightside" href="../src/allocator_api2/stable/slice.rs.html#40-42">source</a><h4 class="code-header">fn <a href="#tymethod.to_vec_in" class="fn">to_vec_in</a>&lt;A: <a class="trait" href="alloc/trait.Allocator.html" title="trait allocator_api2::alloc::Allocator">Allocator</a>&gt;(&amp;self, alloc: A) -&gt; <a class="struct" href="vec/struct.Vec.html" title="struct allocator_api2::vec::Vec">Vec</a>&lt;T, A&gt;<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> with an allocator.</p>
<h5 id="examples"><a href="#examples">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="tymethod.repeat" class="method"><a class="src rightside" href="../src/allocator_api2/stable/slice.rs.html#64-66">source</a><h4 class="code-header">fn <a href="#tymethod.repeat" class="fn">repeat</a>(&amp;self, n: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="vec/struct.Vec.html" title="struct allocator_api2::vec::Vec">Vec</a>&lt;T, <a class="struct" href="alloc/struct.Global.html" title="struct allocator_api2::alloc::Global">Global</a>&gt;<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"><a href="#panics">Panics</a></h5>
<p>This function will panic if the capacity would overflow.</p>
<h5 id="examples-1"><a href="#examples-1">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></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.to_vec" class="method"><a class="src rightside" href="../src/allocator_api2/stable/slice.rs.html#19-24">source</a><h4 class="code-header">fn <a href="#method.to_vec" class="fn">to_vec</a>(&amp;self) -&gt; <a class="struct" href="vec/struct.Vec.html" title="struct allocator_api2::vec::Vec">Vec</a>&lt;T, <a class="struct" href="alloc/struct.Global.html" title="struct allocator_api2::alloc::Global">Global</a>&gt;<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-2"><a href="#examples-2">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></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-SliceExt%3CT%3E-for-%5BT%5D" class="impl"><a class="src rightside" href="../src/allocator_api2/stable/slice.rs.html#69-171">source</a><a href="#impl-SliceExt%3CT%3E-for-%5BT%5D" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.SliceExt.html" title="trait allocator_api2::SliceExt">SliceExt</a>&lt;T&gt; for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.slice.html">[T]</a></h3></section></summary><div class="impl-items"><section id="method.to_vec_in" class="method trait-impl"><a class="src rightside" href="../src/allocator_api2/stable/slice.rs.html#72-110">source</a><a href="#method.to_vec_in" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.to_vec_in" class="fn">to_vec_in</a>&lt;A: <a class="trait" href="alloc/trait.Allocator.html" title="trait allocator_api2::alloc::Allocator">Allocator</a>&gt;(&amp;self, alloc: A) -&gt; <a class="struct" href="vec/struct.Vec.html" title="struct allocator_api2::vec::Vec">Vec</a>&lt;T, A&gt;<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><section id="method.repeat" class="method trait-impl"><a class="src rightside" href="../src/allocator_api2/stable/slice.rs.html#114-170">source</a><a href="#method.repeat" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.repeat" class="fn">repeat</a>(&amp;self, n: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="vec/struct.Vec.html" title="struct allocator_api2::vec::Vec">Vec</a>&lt;T, <a class="struct" href="alloc/struct.Global.html" title="struct allocator_api2::alloc::Global">Global</a>&gt;<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></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/allocator_api2/stable/slice/trait.SliceExt.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html>