|
|
<!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 `Shorten` trait in crate `generic_array`."><meta name="keywords" content="rust, rustlang, rust-lang, Shorten"><title>generic_array::sequence::Shorten - 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">☰</div><a href='../../generic_array/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Shorten</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.Shorter">Shorter</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.pop_back">pop_back</a><a href="#tymethod.pop_front">pop_front</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: 'Shorten', 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'>−</span>]</a></span><a class='srclink' href='../../src/generic_array/sequence.rs.html#147-177' 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=''>Shorten</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait Shorten<T>: <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><T> {
|
|
|
type <a href='#associatedtype.Shorter' class="type">Shorter</a>: <a class="trait" href="../../generic_array/sequence/trait.Lengthen.html" title="trait generic_array::sequence::Lengthen">Lengthen</a><T, Longer = Self>;
|
|
|
fn <a href='#tymethod.pop_back' class='fnname'>pop_back</a>(self) -> (Self::<a class="type" href="../../generic_array/sequence/trait.Shorten.html#associatedtype.Shorter" title="type generic_array::sequence::Shorten::Shorter">Shorter</a>, T);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.pop_front' class='fnname'>pop_front</a>(self) -> (T, Self::<a class="type" href="../../generic_array/sequence/trait.Shorten.html#associatedtype.Shorter" title="type generic_array::sequence::Shorten::Shorter">Shorter</a>);
|
|
|
}</pre></div><div class='docblock'><p>Defines a <code>GenericSequence</code> which can be shortened by removing the first or last element from it.</p>
|
|
|
<p>Additionally, any shortened sequence can be lengthened by
|
|
|
appending or prepending an element to it.</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.Shorter' class='method'><code id='Shorter.t'>type <a href='#associatedtype.Shorter' class="type">Shorter</a>: <a class="trait" href="../../generic_array/sequence/trait.Lengthen.html" title="trait generic_array::sequence::Lengthen">Lengthen</a><T, Longer = Self></code></h3><div class='docblock'><p><code>GenericSequence</code> that has one less 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.pop_back' class='method'><code id='pop_back.v'>fn <a href='#tymethod.pop_back' class='fnname'>pop_back</a>(self) -> (Self::<a class="type" href="../../generic_array/sequence/trait.Shorten.html#associatedtype.Shorter" title="type generic_array::sequence::Shorten::Shorter">Shorter</a>, T)</code></h3><div class='docblock'><p>Returns a new array without the last element, and the last element.</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="number">4</span>];
|
|
|
|
|
|
<span class="kw">let</span> (<span class="ident">init</span>, <span class="ident">last</span>) <span class="op">=</span> <span class="ident">a</span>.<span class="ident">pop_back</span>();
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">init</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="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">last</span>, <span class="number">4</span>);</pre></div>
|
|
|
</div><h3 id='tymethod.pop_front' class='method'><code id='pop_front.v'>fn <a href='#tymethod.pop_front' class='fnname'>pop_front</a>(self) -> (T, Self::<a class="type" href="../../generic_array/sequence/trait.Shorten.html#associatedtype.Shorter" title="type generic_array::sequence::Shorten::Shorter">Shorter</a>)</code></h3><div class='docblock'><p>Returns a new array without the first element, and the first element.
|
|
|
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="number">4</span>];
|
|
|
|
|
|
<span class="kw">let</span> (<span class="ident">head</span>, <span class="ident">tail</span>) <span class="op">=</span> <span class="ident">a</span>.<span class="ident">pop_front</span>();
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">head</span>, <span class="number">1</span>);
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">tail</span>, <span class="macro">arr</span><span class="macro">!</span>[<span class="ident">i32</span>; <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</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-Shorten%3CT%3E' class='impl'><code class='in-band'>impl<T, N: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><T>> Shorten<T> for <a class="struct" href="../../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><T, N> <span class="where fmt-newline">where<br> N: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a><<a class="struct" href="../../typenum/bit/struct.B1.html" title="struct typenum::bit::B1">B1</a>>,<br> <a class="type" href="../../typenum/operator_aliases/type.Sub1.html" title="type typenum::operator_aliases::Sub1">Sub1</a><N>: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><T>,<br> <a class="type" href="../../typenum/operator_aliases/type.Sub1.html" title="type typenum::operator_aliases::Sub1">Sub1</a><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><<a class="struct" href="../../typenum/bit/struct.B1.html" title="struct typenum::bit::B1">B1</a>, Output = N>,<br> <a class="type" href="../../typenum/operator_aliases/type.Add1.html" title="type typenum::operator_aliases::Add1">Add1</a><<a class="type" href="../../typenum/operator_aliases/type.Sub1.html" title="type typenum::operator_aliases::Sub1">Sub1</a><N>>: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><T>, </span></code><a href='#impl-Shorten%3CT%3E' class='anchor'></a><a class='srclink' href='../../src/generic_array/sequence.rs.html#213-245' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Shorter-1' class="type"><code id='Shorter.t-1'>type <a href='#associatedtype.Shorter-1' class="type">Shorter</a> = <a class="struct" href="../../generic_array/struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><T, <a class="type" href="../../typenum/operator_aliases/type.Sub1.html" title="type typenum::operator_aliases::Sub1">Sub1</a><N>></code></h4><h4 id='method.pop_back' class="method hidden"><code id='pop_back.v-1'>fn <a href='#method.pop_back' class='fnname'>pop_back</a>(self) -> (Self::<a class="type" href="../../generic_array/sequence/trait.Shorten.html#associatedtype.Shorter" title="type generic_array::sequence::Shorten::Shorter">Shorter</a>, T)</code><a class='srclink' href='../../src/generic_array/sequence.rs.html#222-232' title='goto source code'>[src]</a></h4><h4 id='method.pop_front' class="method hidden"><code id='pop_front.v-1'>fn <a href='#method.pop_front' class='fnname'>pop_front</a>(self) -> (T, Self::<a class="type" href="../../generic_array/sequence/trait.Shorten.html#associatedtype.Shorter" title="type generic_array::sequence::Shorten::Shorter">Shorter</a>)</code><a class='srclink' href='../../src/generic_array/sequence.rs.html#234-244' 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.Shorten.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>⏎</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> |
