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.Lengthen.html

32 lines
13 KiB

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="API documentation for the Rust `Lengthen` trait in crate `generic_array`."><meta name="keywords" content="rust, rustlang, rust-lang, Lengthen"><title>generic_array::sequence::Lengthen - 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 Lengthen</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.Longer">Longer</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.append">append</a><a href="#tymethod.prepend">prepend</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: 'Lengthen', 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#112-141' 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=''>Lengthen</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait Lengthen&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="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T&gt; {
type <a href='#associatedtype.Longer' class="type">Longer</a>: <a class="trait" href="../../generic_array/sequence/trait.Shorten.html" title="trait generic_array::sequence::Shorten">Shorten</a>&lt;T, Shorter = Self&gt;;
fn <a href='#tymethod.append' class='fnname'>append</a>(self, last: T) -&gt; Self::<a class="type" href="../../generic_array/sequence/trait.Lengthen.html#associatedtype.Longer" title="type generic_array::sequence::Lengthen::Longer">Longer</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.prepend' class='fnname'>prepend</a>(self, first: T) -&gt; Self::<a class="type" href="../../generic_array/sequence/trait.Lengthen.html#associatedtype.Longer" title="type generic_array::sequence::Lengthen::Longer">Longer</a>;
}</pre></div><div class='docblock'><p>Defines any <code>GenericSequence</code> which can be lengthened or extended by appending
or prepending an element to it.</p>
<p>Any lengthened sequence can be shortened back to the original using <code>pop_front</code> or <code>pop_back</code></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.Longer' class='method'><code id='Longer.t'>type <a href='#associatedtype.Longer' class="type">Longer</a>: <a class="trait" href="../../generic_array/sequence/trait.Shorten.html" title="trait generic_array::sequence::Shorten">Shorten</a>&lt;T, Shorter = Self&gt;</code></h3><div class='docblock'><p><code>GenericSequence</code> that has one more element than <code>Self</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.append' class='method'><code id='append.v'>fn <a href='#tymethod.append' class='fnname'>append</a>(self, last: T) -&gt; Self::<a class="type" href="../../generic_array/sequence/trait.Lengthen.html#associatedtype.Longer" title="type generic_array::sequence::Lengthen::Longer">Longer</a></code></h3><div class='docblock'><p>Returns a new array with the given element appended to the end of it.</p>
<p>Example:</p>
<div class='information'><div class='tooltip ignore'><span class='tooltiptext'>This example is not tested</span></div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="macro">arr</span><span class="macro">!</span>[<span class="ident">i32</span>; <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">append</span>(<span class="number">4</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">b</span>, <span class="macro">arr</span><span class="macro">!</span>[<span class="ident">i32</span>; <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);</pre></div>
</div><h3 id='tymethod.prepend' class='method'><code id='prepend.v'>fn <a href='#tymethod.prepend' class='fnname'>prepend</a>(self, first: T) -&gt; Self::<a class="type" href="../../generic_array/sequence/trait.Lengthen.html#associatedtype.Longer" title="type generic_array::sequence::Lengthen::Longer">Longer</a></code></h3><div class='docblock'><p>Returns a new array with the given element prepended to the front of it.</p>
<p>Example:</p>
<div class='information'><div class='tooltip ignore'><span class='tooltiptext'>This example is not tested</span></div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="macro">arr</span><span class="macro">!</span>[<span class="ident">i32</span>; <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">a</span>.<span class="ident">prepend</span>(<span class="number">4</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">b</span>, <span class="macro">arr</span><span class="macro">!</span>[<span class="ident">i32</span>; <span class="number">4</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]);</pre></div>
</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-Lengthen%3CT%3E' class='impl'><code class='in-band'>impl&lt;T, N:&nbsp;<a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;T&gt;&gt; Lengthen&lt;T&gt; for <a class="struct" href="../../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a>&lt;T, N&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a>&lt;<a class="struct" href="../../typenum/bit/struct.B1.html" title="struct typenum::bit::B1">B1</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="../../typenum/operator_aliases/type.Add1.html" title="type typenum::operator_aliases::Add1">Add1</a>&lt;N&gt;: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;T&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="../../typenum/operator_aliases/type.Add1.html" title="type typenum::operator_aliases::Add1">Add1</a>&lt;N&gt;: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a>&lt;<a class="struct" href="../../typenum/bit/struct.B1.html" title="struct typenum::bit::B1">B1</a>, Output = N&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="type" href="../../typenum/operator_aliases/type.Sub1.html" title="type typenum::operator_aliases::Sub1">Sub1</a>&lt;<a class="type" href="../../typenum/operator_aliases/type.Add1.html" title="type typenum::operator_aliases::Add1">Add1</a>&lt;N&gt;&gt;: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-Lengthen%3CT%3E' class='anchor'></a><a class='srclink' href='../../src/generic_array/sequence.rs.html#179-211' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Longer-1' class="type"><code id='Longer.t-1'>type <a href='#associatedtype.Longer-1' class="type">Longer</a> = <a class="struct" href="../../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a>&lt;T, <a class="type" href="../../typenum/operator_aliases/type.Add1.html" title="type typenum::operator_aliases::Add1">Add1</a>&lt;N&gt;&gt;</code></h4><h4 id='method.append' class="method hidden"><code id='append.v-1'>fn <a href='#method.append' class='fnname'>append</a>(self, last: T) -&gt; Self::<a class="type" href="../../generic_array/sequence/trait.Lengthen.html#associatedtype.Longer" title="type generic_array::sequence::Lengthen::Longer">Longer</a></code><a class='srclink' href='../../src/generic_array/sequence.rs.html#188-197' title='goto source code'>[src]</a></h4><h4 id='method.prepend' class="method hidden"><code id='prepend.v-1'>fn <a href='#method.prepend' class='fnname'>prepend</a>(self, first: T) -&gt; Self::<a class="type" href="../../generic_array/sequence/trait.Lengthen.html#associatedtype.Longer" title="type generic_array::sequence::Lengthen::Longer">Longer</a></code><a class='srclink' href='../../src/generic_array/sequence.rs.html#199-210' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../implementors/generic_array/sequence/trait.Lengthen.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>