Files
trussed/generic_array/functional/trait.FunctionalSequence.html
T
2022-06-27 12:01:23 +00:00

25 lines
19 KiB
HTML
Raw 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="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script>
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../generic_array/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">FunctionalSequence</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><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></div><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><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></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In generic_array::functional</a></h2><div id="sidebar-vars" data-name="FunctionalSequence" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../generic_array/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">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="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/generic_array/functional.rs.html#43-83">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock 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="fnname">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; <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.61.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.61.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="fnname">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; <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;,<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;Rhs: <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;F: <a class="trait" href="https://doc.rust-lang.org/1.61.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.61.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.61.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="fnname">fold</a>&lt;U, F&gt;(self, init: U, f: F) -&gt; U<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/1.61.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.61.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" open><summary><div id="method.map" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/generic_array/functional.rs.html#48-55">source</a></div><h4 class="code-header">fn <a href="#method.map" class="fnname">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.61.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.61.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -&gt; U,&nbsp;</span></h4></div></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" open><summary><div id="method.zip" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/generic_array/functional.rs.html#63-72">source</a></div><h4 class="code-header">fn <a href="#method.zip" class="fnname">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;,<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;Rhs: <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;F: <a class="trait" href="https://doc.rust-lang.org/1.61.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.61.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.61.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -&gt; U,&nbsp;</span></h4></div></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" open><summary><div id="method.fold" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/generic_array/functional.rs.html#77-82">source</a></div><h4 class="code-header">fn <a href="#method.fold" class="fnname">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.61.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.61.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -&gt; U,&nbsp;</span></h4></div></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"><span class="rightside"><a class="srclink" href="../../src/generic_array/functional.rs.html#85-89">source</a></span><a href="#impl-FunctionalSequence%3CT%3E-for-%26%27a%20S" class="anchor"></a><h3 class="code-header in-band">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.61.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.61.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;,&nbsp;</span></h3></section><section id="impl-FunctionalSequence%3CT%3E-for-%26%27a%20mut%20S" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/generic_array/functional.rs.html#91-95">source</a></span><a href="#impl-FunctionalSequence%3CT%3E-for-%26%27a%20mut%20S" class="anchor"></a><h3 class="code-header in-band">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.61.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.61.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;,&nbsp;</span></h3></section><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-FunctionalSequence%3CT%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/generic_array/lib.rs.html#462-518">source</a></span><a href="#impl-FunctionalSequence%3CT%3E" class="anchor"></a><h3 class="code-header in-band">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;,&nbsp;</span></h3></section></div><script type="text/javascript" src="../../implementors/generic_array/functional/trait.FunctionalSequence.js" async></script></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="generic_array" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.61.0 (fe5b13d68 2022-05-18)" ></div>
</body></html>