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

18 lines
19 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 functional programming methods for generic sequences"><meta name="keywords" content="rust, rustlang, rust-lang, FunctionalSequence"><title>FunctionalSequence in generic_array::functional - 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="#">FunctionalSequence</a></h2><div class="sidebar-elems"><section><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.fold">fold</a></li><li><a href="#method.map">map</a></li><li><a href="#method.zip">zip</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-FunctionalSequence%3CT%3E-for-%26%27a%20S">&amp;&#39;a S</a></li><li><a href="#impl-FunctionalSequence%3CT%3E-for-%26%27a%20mut%20S">&amp;&#39;a mut S</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In generic_array::functional</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">functional</a>::<wbr><a class="trait" href="#">FunctionalSequence</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/functional.rs.html#43-83">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 FunctionalSequence&lt;T&gt;: <a class="trait" href="../sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T&gt; {
fn <a href="#method.map" class="fn">map</a>&lt;U, F&gt;(self, f: F) -&gt; <a class="type" href="type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a>&lt;Self, T, U&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a>&lt;T, U&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="associatedtype" href="../sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>: <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;U&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -&gt; U</span>,
{ ... }
<span class="item-spacer"></span> fn <a href="#method.zip" class="fn">zip</a>&lt;B, Rhs, U, F&gt;(self, rhs: Rhs, f: F) -&gt; <a class="type" href="type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a>&lt;Self, T, U&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a>&lt;T, U&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Rhs: <a class="trait" href="trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a>&lt;B, U, Mapped = <a class="type" href="type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a>&lt;Self, T, U&gt;&gt; + <a class="trait" href="../sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;B, Length = Self::<a class="associatedtype" href="../sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="associatedtype" href="../sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>: <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;B&gt; + <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;U&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>, Rhs::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -&gt; U</span>,
{ ... }
<span class="item-spacer"></span> fn <a href="#method.fold" class="fn">fold</a>&lt;U, F&gt;(self, init: U, f: F) -&gt; U<br>&nbsp;&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/1.67.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(U, Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -&gt; U</span>,
{ ... }
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Defines functional programming methods for generic sequences</p>
</div></details><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map" class="method has-srclink"><a class="srclink rightside" href="../../src/generic_array/functional.rs.html#48-55">source</a><h4 class="code-header">fn <a href="#method.map" class="fn">map</a>&lt;U, F&gt;(self, f: F) -&gt; <a class="type" href="type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a>&lt;Self, T, U&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a>&lt;T, U&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="associatedtype" href="../sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>: <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;U&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -&gt; U,</span></h4></section></summary><div class="docblock"><p>Maps a <code>GenericSequence</code> to another <code>GenericSequence</code>.</p>
<p>If the mapping function panics, any already initialized elements in the new sequence
will be dropped, AND any unused elements in the source sequence will also be dropped.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.zip" class="method has-srclink"><a class="srclink rightside" href="../../src/generic_array/functional.rs.html#63-72">source</a><h4 class="code-header">fn <a href="#method.zip" class="fn">zip</a>&lt;B, Rhs, U, F&gt;(self, rhs: Rhs, f: F) -&gt; <a class="type" href="type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a>&lt;Self, T, U&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a>&lt;T, U&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Rhs: <a class="trait" href="trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a>&lt;B, U, Mapped = <a class="type" href="type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a>&lt;Self, T, U&gt;&gt; + <a class="trait" href="../sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;B, Length = Self::<a class="associatedtype" href="../sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="associatedtype" href="../sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>: <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;B&gt; + <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;U&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>, Rhs::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -&gt; U,</span></h4></section></summary><div class="docblock"><p>Combines two <code>GenericSequence</code> instances and iterates through both of them,
initializing a new <code>GenericSequence</code> with the result of the zipped mapping function.</p>
<p>If the mapping function panics, any already initialized elements in the new sequence
will be dropped, AND any unused elements in the source sequences will also be dropped.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fold" class="method has-srclink"><a class="srclink rightside" href="../../src/generic_array/functional.rs.html#77-82">source</a><h4 class="code-header">fn <a href="#method.fold" class="fn">fold</a>&lt;U, F&gt;(self, init: U, f: F) -&gt; U<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/1.67.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(U, Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.67.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -&gt; U,</span></h4></section></summary><div class="docblock"><p>Folds (or reduces) a sequence of data into a single value.</p>
<p>If the fold function panics, any unused elements will be dropped.</p>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-FunctionalSequence%3CT%3E-for-%26%27a%20S" class="impl has-srclink"><a class="srclink rightside" href="../../src/generic_array/functional.rs.html#85-89">source</a><a href="#impl-FunctionalSequence%3CT%3E-for-%26%27a%20S" class="anchor">§</a><h3 class="code-header">impl&lt;'a, T, S:&nbsp;<a class="trait" href="../sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T&gt;&gt; <a class="trait" href="trait.FunctionalSequence.html" title="trait generic_array::functional::FunctionalSequence">FunctionalSequence</a>&lt;T&gt; for <a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.reference.html">&amp;'a </a>S<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.reference.html">&amp;'a </a>S: <a class="trait" href="../sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T&gt;,</span></h3></section><section id="impl-FunctionalSequence%3CT%3E-for-%26%27a%20mut%20S" class="impl has-srclink"><a class="srclink rightside" href="../../src/generic_array/functional.rs.html#91-95">source</a><a href="#impl-FunctionalSequence%3CT%3E-for-%26%27a%20mut%20S" class="anchor">§</a><h3 class="code-header">impl&lt;'a, T, S:&nbsp;<a class="trait" href="../sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T&gt;&gt; <a class="trait" href="trait.FunctionalSequence.html" title="trait generic_array::functional::FunctionalSequence">FunctionalSequence</a>&lt;T&gt; for <a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.reference.html">&amp;'a mut </a>S<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="primitive" href="https://doc.rust-lang.org/1.67.0/core/primitive.reference.html">&amp;'a mut </a>S: <a class="trait" href="../sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T&gt;,</span></h3></section><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-FunctionalSequence%3CT%3E-for-GenericArray%3CT%2C%20N%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/generic_array/lib.rs.html#468-524">source</a><a href="#impl-FunctionalSequence%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.FunctionalSequence.html" title="trait generic_array::functional::FunctionalSequence">FunctionalSequence</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="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a>&lt;T&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="../sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a>&lt;T, Item = T, Length = N&gt;,</span></h3></section></div><script src="../../implementors/generic_array/functional/trait.FunctionalSequence.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>