216 lines
No EOL
16 KiB
HTML
216 lines
No EOL
16 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="API documentation for the Rust `Extend` trait in crate `bitflags`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Extend">
|
||
|
||
<title>bitflags::__core::iter::Extend - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>iter</a></p><script>window.sidebarCurrent = {name: 'Extend', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content trait">
|
||
<h1 class='fqn'><span class='in-band'>Trait <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>iter</a>::<wbr><a class='trait' href=''>Extend</a></span><span class='out-of-band'><span id='render-detail'>
|
||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||
[<span class='inner'>−</span>]
|
||
</a>
|
||
</span><a id='src-29007' class='srclink' href='https://doc.rust-lang.org/nightly/core/iter/trait.Extend.html?gotosrc=29007' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait Extend<A> {
|
||
fn <a href='#tymethod.extend' class='fnname'>extend</a><T>(&mut self, iter: T) <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/iter/trait.IntoIterator.html' title='bitflags::__core::iter::IntoIterator'>IntoIterator</a><Item=A></span>;
|
||
}</pre><div class='docblock'><p>Extend a collection with the contents of an iterator.</p>
|
||
|
||
<p>Iterators produce a series of values, and collections can also be thought
|
||
of as a series of values. The <code>Extend</code> trait bridges this gap, allowing you
|
||
to extend a collection by including the contents of that iterator.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<p>Basic usage:</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='comment'>// You can extend a String with some chars:</span>
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>message</span> <span class='op'>=</span> <span class='ident'>String</span>::<span class='ident'>from</span>(<span class='string'>"The first three letters are: "</span>);
|
||
|
||
<span class='ident'>message</span>.<span class='ident'>extend</span>(<span class='kw-2'>&</span>[<span class='string'>'a'</span>, <span class='string'>'b'</span>, <span class='string'>'c'</span>]);
|
||
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>"abc"</span>, <span class='kw-2'>&</span><span class='ident'>message</span>[<span class='number'>29</span>..<span class='number'>32</span>]);</pre>
|
||
|
||
<p>Implementing <code>Extend</code>:</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='comment'>// A sample collection, that's just a wrapper over Vec<T></span>
|
||
<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Debug</span>)]</span>
|
||
<span class='kw'>struct</span> <span class='ident'>MyCollection</span>(<span class='ident'>Vec</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span>);
|
||
|
||
<span class='comment'>// Let's give it some methods so we can create one and add things</span>
|
||
<span class='comment'>// to it.</span>
|
||
<span class='kw'>impl</span> <span class='ident'>MyCollection</span> {
|
||
<span class='kw'>fn</span> <span class='ident'>new</span>() <span class='op'>-></span> <span class='ident'>MyCollection</span> {
|
||
<span class='ident'>MyCollection</span>(<span class='ident'>Vec</span>::<span class='ident'>new</span>())
|
||
}
|
||
|
||
<span class='kw'>fn</span> <span class='ident'>add</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>elem</span>: <span class='ident'>i32</span>) {
|
||
<span class='self'>self</span>.<span class='number'>0</span>.<span class='ident'>push</span>(<span class='ident'>elem</span>);
|
||
}
|
||
}
|
||
|
||
<span class='comment'>// since MyCollection has a list of i32s, we implement Extend for i32</span>
|
||
<span class='kw'>impl</span> <span class='ident'>Extend</span><span class='op'><</span><span class='ident'>i32</span><span class='op'>></span> <span class='kw'>for</span> <span class='ident'>MyCollection</span> {
|
||
|
||
<span class='comment'>// This is a bit simpler with the concrete type signature: we can call</span>
|
||
<span class='comment'>// extend on anything which can be turned into an Iterator which gives</span>
|
||
<span class='comment'>// us i32s. Because we need i32s to put into MyCollection.</span>
|
||
<span class='kw'>fn</span> <span class='ident'>extend</span><span class='op'><</span><span class='ident'>T</span>: <span class='ident'>IntoIterator</span><span class='op'><</span><span class='ident'>Item</span><span class='op'>=</span><span class='ident'>i32</span><span class='op'>>></span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>, <span class='ident'>iter</span>: <span class='ident'>T</span>) {
|
||
|
||
<span class='comment'>// The implementation is very straightforward: loop through the</span>
|
||
<span class='comment'>// iterator, and add() each element to ourselves.</span>
|
||
<span class='kw'>for</span> <span class='ident'>elem</span> <span class='kw'>in</span> <span class='ident'>iter</span> {
|
||
<span class='self'>self</span>.<span class='ident'>add</span>(<span class='ident'>elem</span>);
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='ident'>MyCollection</span>::<span class='ident'>new</span>();
|
||
|
||
<span class='ident'>c</span>.<span class='ident'>add</span>(<span class='number'>5</span>);
|
||
<span class='ident'>c</span>.<span class='ident'>add</span>(<span class='number'>6</span>);
|
||
<span class='ident'>c</span>.<span class='ident'>add</span>(<span class='number'>7</span>);
|
||
|
||
<span class='comment'>// let's extend our collection with three more numbers</span>
|
||
<span class='ident'>c</span>.<span class='ident'>extend</span>(<span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>]);
|
||
|
||
<span class='comment'>// we've added these elements onto the end</span>
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>"MyCollection([5, 6, 7, 1, 2, 3])"</span>, <span class='macro'>format</span><span class='macro'>!</span>(<span class='string'>"{:?}"</span>, <span class='ident'>c</span>));</pre>
|
||
</div>
|
||
<h2 id='required-methods'>Required Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.extend' class='method stab '><code>fn <a href='#tymethod.extend' class='fnname'>extend</a><T>(&mut self, iter: T) <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/iter/trait.IntoIterator.html' title='bitflags::__core::iter::IntoIterator'>IntoIterator</a><Item=A></span></code></h3><div class='docblock'><p>Extends a collection with the contents of an iterator.</p>
|
||
|
||
<p>As this is the only method for this trait, the <a href="trait.Extend.html">trait-level</a> docs
|
||
contain more details.</p>
|
||
|
||
<h1 id='examples-1' class='section-header'><a href='#examples-1'>Examples</a></h1>
|
||
<p>Basic usage:</p>
|
||
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='comment'>// You can extend a String with some chars:</span>
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>message</span> <span class='op'>=</span> <span class='ident'>String</span>::<span class='ident'>from</span>(<span class='string'>"abc"</span>);
|
||
|
||
<span class='ident'>message</span>.<span class='ident'>extend</span>([<span class='string'>'d'</span>, <span class='string'>'e'</span>, <span class='string'>'f'</span>].<span class='ident'>iter</span>());
|
||
|
||
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='string'>"abcdef"</span>, <span class='kw-2'>&</span><span class='ident'>message</span>);</pre>
|
||
</div></div>
|
||
<h2 id='implementors'>Implementors</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><code>impl<'a, T> Extend for <a class='struct' href='../../../bitflags/__core/vec/struct.Vec.html' title='bitflags::__core::vec::Vec'>Vec</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a> + 'a</span></code></li>
|
||
<li><code>impl<T> Extend for <a class='struct' href='../../../bitflags/__core/vec/struct.Vec.html' title='bitflags::__core::vec::Vec'>Vec</a><T></code></li>
|
||
<li><code>impl Extend for <a class='struct' href='../../../bitflags/__core/string/struct.String.html' title='bitflags::__core::string::String'>String</a></code></li>
|
||
<li><code>impl<'a> Extend for <a class='struct' href='../../../bitflags/__core/string/struct.String.html' title='bitflags::__core::string::String'>String</a></code></li>
|
||
<li><code>impl<'a> Extend for <a class='struct' href='../../../bitflags/__core/string/struct.String.html' title='bitflags::__core::string::String'>String</a></code></li>
|
||
<li><code>impl Extend for <a class='struct' href='../../../bitflags/__core/string/struct.String.html' title='bitflags::__core::string::String'>String</a></code></li>
|
||
<li><code>impl<'a, T> Extend for <a class='struct' href='../../../bitflags/__core/collections/linked_list/struct.LinkedList.html' title='bitflags::__core::collections::linked_list::LinkedList'>LinkedList</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a> + 'a</span></code></li>
|
||
<li><code>impl<A> Extend for <a class='struct' href='../../../bitflags/__core/collections/linked_list/struct.LinkedList.html' title='bitflags::__core::collections::linked_list::LinkedList'>LinkedList</a><A></code></li>
|
||
<li><code>impl<'a, T> Extend for <a class='struct' href='../../../bitflags/__core/collections/binary_heap/struct.BinaryHeap.html' title='bitflags::__core::collections::binary_heap::BinaryHeap'>BinaryHeap</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a> + 'a + <a class='trait' href='../../../bitflags/__core/cmp/trait.Ord.html' title='bitflags::__core::cmp::Ord'>Ord</a></span></code></li>
|
||
<li><code>impl<T> Extend for <a class='struct' href='../../../bitflags/__core/collections/binary_heap/struct.BinaryHeap.html' title='bitflags::__core::collections::binary_heap::BinaryHeap'>BinaryHeap</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Ord.html' title='bitflags::__core::cmp::Ord'>Ord</a></span></code></li>
|
||
<li><code>impl<'a, T> Extend for <a class='struct' href='../../../bitflags/__core/collections/vec_deque/struct.VecDeque.html' title='bitflags::__core::collections::vec_deque::VecDeque'>VecDeque</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a> + 'a</span></code></li>
|
||
<li><code>impl<A> Extend for <a class='struct' href='../../../bitflags/__core/collections/vec_deque/struct.VecDeque.html' title='bitflags::__core::collections::vec_deque::VecDeque'>VecDeque</a><A></code></li>
|
||
<li><code>impl<'a, K, V> Extend for <a class='struct' href='../../../bitflags/__core/collections/struct.BTreeMap.html' title='bitflags::__core::collections::BTreeMap'>BTreeMap</a><K, V> <span class='where'>where V: <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a>, K: <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a> + <a class='trait' href='../../../bitflags/__core/cmp/trait.Ord.html' title='bitflags::__core::cmp::Ord'>Ord</a></span></code></li>
|
||
<li><code>impl<K, V> Extend for <a class='struct' href='../../../bitflags/__core/collections/struct.BTreeMap.html' title='bitflags::__core::collections::BTreeMap'>BTreeMap</a><K, V> <span class='where'>where K: <a class='trait' href='../../../bitflags/__core/cmp/trait.Ord.html' title='bitflags::__core::cmp::Ord'>Ord</a></span></code></li>
|
||
<li><code>impl<'a, T> Extend for <a class='struct' href='../../../bitflags/__core/collections/btree_set/struct.BTreeSet.html' title='bitflags::__core::collections::btree_set::BTreeSet'>BTreeSet</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a> + 'a + <a class='trait' href='../../../bitflags/__core/cmp/trait.Ord.html' title='bitflags::__core::cmp::Ord'>Ord</a></span></code></li>
|
||
<li><code>impl<T> Extend for <a class='struct' href='../../../bitflags/__core/collections/btree_set/struct.BTreeSet.html' title='bitflags::__core::collections::btree_set::BTreeSet'>BTreeSet</a><T> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Ord.html' title='bitflags::__core::cmp::Ord'>Ord</a></span></code></li>
|
||
</ul><script type="text/javascript" async
|
||
src="../../../implementors/core/iter/trait.Extend.js">
|
||
</script></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../../";
|
||
window.currentCrate = "bitflags";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../../jquery.js"></script>
|
||
<script src="../../../main.js"></script>
|
||
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |