Files
oath-authenticator/generic_array/sequence/trait.Shorten.html
2023-01-30 23:51:12 +00:00

28 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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="Defines a `GenericSequence` which can be shortened by removing the first or last element from it."><meta name="keywords" content="rust, rustlang, rust-lang, Shorten"><title>Shorten in generic_array::sequence - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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/SourceSerif4-Bold-124a1ca42af929b6.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-6827029ac823cab7.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../../static.files/ayu-8af5e100b21cd173.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-c55e1eb52e1886b4.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.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><a class="sidebar-logo" href="../../generic_array/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../generic_array/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2 class="location"><a href="#">Shorten</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Shorter">Shorter</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.pop_back">pop_back</a></li><li><a href="#tymethod.pop_front">pop_front</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In generic_array::sequence</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><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" title="help" tabindex="-1"><a href="../../help.html">?</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-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../index.html">generic_array</a>::<wbr><a href="index.html">sequence</a>::<wbr><a class="trait" href="#">Shorten</a><button id="copy-path" onclick="copy_path(this)" 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="srclink" href="../../src/generic_array/sequence.rs.html#152-188">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><div class="item-decl"><pre class="rust trait"><code>pub unsafe trait Shorten&lt;T&gt;: <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T&gt; {
type <a href="#associatedtype.Shorter" class="associatedtype">Shorter</a>: <a class="trait" href="trait.Lengthen.html" title="trait generic_array::sequence::Lengthen">Lengthen</a>&lt;T, Longer = Self&gt;;
fn <a href="#tymethod.pop_back" class="fn">pop_back</a>(self) -&gt; (Self::<a class="associatedtype" href="trait.Shorten.html#associatedtype.Shorter" title="type generic_array::sequence::Shorten::Shorter">Shorter</a>, T);
<span class="item-spacer"></span> fn <a href="#tymethod.pop_front" class="fn">pop_front</a>(self) -&gt; (T, Self::<a class="associatedtype" href="trait.Shorten.html#associatedtype.Shorter" title="type generic_array::sequence::Shorten::Shorter">Shorter</a>);
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Shorter" class="method has-srclink"><a class="srclink rightside" href="../../src/generic_array/sequence.rs.html#154">source</a><h4 class="code-header">type <a href="#associatedtype.Shorter" class="associatedtype">Shorter</a>: <a class="trait" href="trait.Lengthen.html" title="trait generic_array::sequence::Lengthen">Lengthen</a>&lt;T, Longer = Self&gt;</h4></section></summary><div class="docblock"><p><code>GenericSequence</code> that has one less element than <code>Self</code></p>
</div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.pop_back" class="method has-srclink"><a class="srclink rightside" href="../../src/generic_array/sequence.rs.html#171">source</a><h4 class="code-header">fn <a href="#tymethod.pop_back" class="fn">pop_back</a>(self) -&gt; (Self::<a class="associatedtype" href="trait.Shorten.html#associatedtype.Shorter" title="type generic_array::sequence::Shorten::Shorter">Shorter</a>, T)</h4></section></summary><div class="docblock"><p>Returns a new array without the last element, and the last element.</p>
<p>Example:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>a = <span class="macro">arr!</span>[i32; <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>(init, last) = a.pop_back();
<span class="macro">assert_eq!</span>(init, <span class="macro">arr!</span>[i32; <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]);
<span class="macro">assert_eq!</span>(last, <span class="number">4</span>);</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.pop_front" class="method has-srclink"><a class="srclink rightside" href="../../src/generic_array/sequence.rs.html#187">source</a><h4 class="code-header">fn <a href="#tymethod.pop_front" class="fn">pop_front</a>(self) -&gt; (T, Self::<a class="associatedtype" href="trait.Shorten.html#associatedtype.Shorter" title="type generic_array::sequence::Shorten::Shorter">Shorter</a>)</h4></section></summary><div class="docblock"><p>Returns a new array without the first element, and the first element.
Example:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>a = <span class="macro">arr!</span>[i32; <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>(head, tail) = a.pop_front();
<span class="macro">assert_eq!</span>(head, <span class="number">1</span>);
<span class="macro">assert_eq!</span>(tail, <span class="macro">arr!</span>[i32; <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>]);</code></pre></div>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Shorten%3CT%3E-for-GenericArray%3CT%2C%20N%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/generic_array/sequence.rs.html#232-263">source</a><a href="#impl-Shorten%3CT%3E-for-GenericArray%3CT%2C%20N%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, N&gt; <a class="trait" href="trait.Shorten.html" title="trait generic_array::sequence::Shorten">Shorten</a>&lt;T&gt; for <a class="struct" href="../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/1.67.0/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>&gt; + <a class="trait" href="../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.Sub1.html" title="type typenum::operator_aliases::Sub1">Sub1</a>&lt;N&gt;: <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;T&gt; + <a class="trait" href="https://doc.rust-lang.org/1.67.0/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>, Output = N&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;<a class="type" href="../../typenum/operator_aliases/type.Sub1.html" title="type typenum::operator_aliases::Sub1">Sub1</a>&lt;N&gt;&gt;: <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Shorter-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Shorter-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Shorter" class="associatedtype">Shorter</a> = <a class="struct" href="../struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a>&lt;T, &lt;N as <a class="trait" href="https://doc.rust-lang.org/1.67.0/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>&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/ops/arith/trait.Sub.html#associatedtype.Output" title="type core::ops::arith::Sub::Output">Output</a>&gt;</h4></section></div></details></div><script src="../../implementors/generic_array/sequence/trait.Shorten.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="generic_array" data-themes="" data-resource-suffix="" data-rustdoc-version="1.67.0 (fc594f156 2023-01-24)" data-search-js="search-444266647c4dba98.js" data-settings-js="settings-bebeae96e00e4617.js" data-settings-css="settings-af96d9e2fc13e081.css" ></div></body></html>