You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Trac3r-rust/doc/generic_array/sequence/trait.GenericSequence.html

17 lines
15 KiB

5 years ago
<!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 `GenericSequence` trait in crate `generic_array`."><meta name="keywords" content="rust, rustlang, rust-lang, GenericSequence"><title>generic_array::sequence::GenericSequence - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../generic_array/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait GenericSequence</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Length">Length</a><a href="#associatedtype.Sequence">Sequence</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.generate">generate</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>generic_array</a>::<wbr><a href='index.html'>sequence</a></p><script>window.sidebarCurrent = {name: 'GenericSequence', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/generic_array/sequence.rs.html#11-68' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>generic_array</a>::<wbr><a href='index.html'>sequence</a>::<wbr><a class="trait" href=''>GenericSequence</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait GenericSequence&lt;T&gt;: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> {
type <a href='#associatedtype.Length' class="type">Length</a>: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;T&gt;;
type <a href='#associatedtype.Sequence' class="type">Sequence</a>: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T, Length = Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html" title="trait core::iter::traits::collect::FromIterator">FromIterator</a>&lt;T&gt;;
fn <a href='#tymethod.generate' class='fnname'>generate</a>&lt;F&gt;(f: F) -&gt; Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a><br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(usize) -&gt; T</span>;
}</pre></div><div class='docblock'><p>Defines some sequence with an associated length and iteration capabilities.</p>
<p>This is useful for passing N-length generic arrays as generics.</p>
</div>
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Length' class='method'><code id='Length.t'>type <a href='#associatedtype.Length' class="type">Length</a>: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;T&gt;</code></h3><div class='docblock'><p><code>GenericArray</code> associated length</p>
</div><h3 id='associatedtype.Sequence' class='method'><code id='Sequence.t'>type <a href='#associatedtype.Sequence' class="type">Sequence</a>: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T, Length = Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html" title="trait core::iter::traits::collect::FromIterator">FromIterator</a>&lt;T&gt;</code></h3><div class='docblock'><p>Concrete sequence type used in conjuction with reference implementations of <code>GenericSequence</code></p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.generate' class='method'><code id='generate.v'>fn <a href='#tymethod.generate' class='fnname'>generate</a>&lt;F&gt;(f: F) -&gt; Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(usize) -&gt; T,&nbsp;</span></code></h3><div class='docblock'><p>Initializes a new sequence instance using the given function.</p>
<p>If the generator function panics while initializing the sequence,
any already initialized elements will be dropped.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-GenericSequence%3CT%3E' class='impl'><code class='in-band'>impl&lt;'a, T:&nbsp;'a, S:&nbsp;<a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T&gt;&gt; GenericSequence&lt;T&gt; for &amp;'a S <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'a S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,&nbsp;</span></code><a href='#impl-GenericSequence%3CT%3E' class='anchor'></a><a class='srclink' href='../../src/generic_array/sequence.rs.html#76-90' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Length-1' class="type"><code id='Length.t-1'>type <a href='#associatedtype.Length-1' class="type">Length</a> = S::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a></code></h4><h4 id='associatedtype.Sequence-1' class="type"><code id='Sequence.t-1'>type <a href='#associatedtype.Sequence-1' class="type">Sequence</a> = S::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a></code></h4><h4 id='method.generate' class="method hidden"><code id='generate.v-1'>fn <a href='#method.generate' class='fnname'>generate</a>&lt;F&gt;(f: F) -&gt; Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(usize) -&gt; T,&nbsp;</span></code><a class='srclink' href='../../src/generic_array/sequence.rs.html#84-89' title='goto source code'>[src]</a></h4></div><h3 id='impl-GenericSequence%3CT%3E-1' class='impl'><code class='in-band'>impl&lt;'a, T:&nbsp;'a, S:&nbsp;<a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T&gt;&gt; GenericSequence&lt;T&gt; for &amp;'a mut S <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'a mut S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,&nbsp;</span></code><a href='#impl-GenericSequence%3CT%3E-1' class='anchor'></a><a class='srclink' href='../../src/generic_array/sequence.rs.html#92-106' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Length-2' class="type"><code id='Length.t-2'>type <a href='#associatedtype.Length-2' class="type">Length</a> = S::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a></code></h4><h4 id='associatedtype.Sequence-2' class="type"><code id='Sequence.t-2'>type <a href='#associatedtype.Sequence-2' class="type">Sequence</a> = S::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a></code></h4><h4 id='method.generate-1' class="method hidden"><code id='generate.v-2'>fn <a href='#method.generate-1' class='fnname'>generate</a>&lt;F&gt;(f: F) -&gt; Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequenc
src="../../implementors/generic_array/sequence/trait.GenericSequence.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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "generic_array";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>