mirror of
https://github.com/rust-embedded/heapless.git
synced 2025-10-02 23:04:40 +00:00
21 lines
21 KiB
HTML
21 lines
21 KiB
HTML
<!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 `FunctionalSequence` trait in crate `generic_array`."><meta name="keywords" content="rust, rustlang, rust-lang, FunctionalSequence"><title>generic_array::functional::FunctionalSequence - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><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 rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait FunctionalSequence</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.fold">fold</a><a href="#method.map">map</a><a href="#method.zip">zip</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">functional</a></p><script>window.sidebarCurrent = {name: "FunctionalSequence", 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!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<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/functional.rs.html#43-83" title="goto source code">[src]</a></span><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></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub unsafe trait FunctionalSequence<T>: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T> {
|
||
fn <a href="#method.map" class="fnname">map</a><U, F>(self, f: F) -> <a class="type" href="../../generic_array/functional/type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a><Self, T, U><br> <span class="where">where<br> Self: <a class="trait" href="../../generic_array/functional/trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a><T, U>,<br> Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><U>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -> U</span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.zip" class="fnname">zip</a><B, Rhs, U, F>(self, rhs: Rhs, f: F) -> <a class="type" href="../../generic_array/functional/type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a><Self, T, U><br> <span class="where">where<br> Self: <a class="trait" href="../../generic_array/functional/trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a><T, U>,<br> Rhs: <a class="trait" href="../../generic_array/functional/trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a><B, U, Mapped = <a class="type" href="../../generic_array/functional/type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a><Self, T, U>>,<br> Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><B> + <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><U>,<br> Rhs: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><B, Length = Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>, Rhs::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -> U</span>,
|
||
{ ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.fold" class="fnname">fold</a><U, F>(self, init: U, f: F) -> U<br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(U, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -> U</span>,
|
||
{ ... }
|
||
}</pre></div><div class="docblock"><p>Defines functional programming methods for generic sequences</p>
|
||
</div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.map" class="method"><code>fn <a href="#method.map" class="fnname">map</a><U, F>(self, f: F) -> <a class="type" href="../../generic_array/functional/type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a><Self, T, U> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../generic_array/functional/trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a><T, U>,<br> Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><U>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -> U, </span></code><a class="srclink" href="../../src/generic_array/functional.rs.html#48-55" title="goto source code">[src]</a></h3><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><h3 id="method.zip" class="method"><code>fn <a href="#method.zip" class="fnname">zip</a><B, Rhs, U, F>(self, rhs: Rhs, f: F) -> <a class="type" href="../../generic_array/functional/type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a><Self, T, U> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../generic_array/functional/trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a><T, U>,<br> Rhs: <a class="trait" href="../../generic_array/functional/trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a><B, U, Mapped = <a class="type" href="../../generic_array/functional/type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a><Self, T, U>>,<br> Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><B> + <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><U>,<br> Rhs: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><B, Length = Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>, Rhs::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -> U, </span></code><a class="srclink" href="../../src/generic_array/functional.rs.html#63-72" title="goto source code">[src]</a></h3><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><h3 id="method.fold" class="method"><code>fn <a href="#method.fold" class="fnname">fold</a><U, F>(self, init: U, f: F) -> U <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(U, Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -> U, </span></code><a class="srclink" href="../../src/generic_array/functional.rs.html#77-82" title="goto source code">[src]</a></h3><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></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-FunctionalSequence%3CT%3E" class="impl"><code class="in-band">impl<'a, T, S: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T>> FunctionalSequence<T> for &'a S <span class="where fmt-newline">where<br> &'a S: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T>, </span></code><a href="#impl-FunctionalSequence%3CT%3E" class="anchor"></a><a class="srclink" href="../../src/generic_array/functional.rs.html#85-89" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-FunctionalSequence%3CT%3E-1" class="impl"><code class="in-band">impl<'a, T, S: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T>> FunctionalSequence<T> for &'a mut S <span class="where fmt-newline">where<br> &'a mut S: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T>, </span></code><a href="#impl-FunctionalSequence%3CT%3E-1" class="anchor"></a><a class="srclink" href="../../src/generic_array/functional.rs.html#91-95" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-FunctionalSequence%3CT%3E-2" class="impl"><code class="in-band">impl<T, N> FunctionalSequence<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="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><T>,<br> Self: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T, Item = T, Length = N>, </span></code><a href="#impl-FunctionalSequence%3CT%3E-2" class="anchor"></a><a class="srclink" href="../../src/generic_array/lib.rs.html#462-518" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.map-1" class="method hidden"><code>fn <a href="#method.map-1" class="fnname">map</a><U, F>(self, f: F) -> <a class="type" href="../../generic_array/functional/type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a><Self, T, U> <span class="where fmt-newline">where<br> Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><U>,<br> Self: <a class="trait" href="../../generic_array/functional/trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a><T, U>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(T) -> U, </span></code><a class="srclink" href="../../src/generic_array/lib.rs.html#467-486" title="goto source code">[src]</a></h4><h4 id="method.zip-1" class="method hidden"><code>fn <a href="#method.zip-1" class="fnname">zip</a><B, Rhs, U, F>(self, rhs: Rhs, f: F) -> <a class="type" href="../../generic_array/functional/type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a><Self, T, U> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../../generic_array/functional/trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a><T, U>,<br> Rhs: <a class="trait" href="../../generic_array/functional/trait.MappedGenericSequence.html" title="trait generic_array::functional::MappedGenericSequence">MappedGenericSequence</a><B, U, Mapped = <a class="type" href="../../generic_array/functional/type.MappedSequence.html" title="type generic_array::functional::MappedSequence">MappedSequence</a><Self, T, U>>,<br> Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>: <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><B> + <a class="trait" href="../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><U>,<br> Rhs: <a class="trait" href="../../generic_array/sequence/trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><B, Length = Self::<a class="type" href="../../generic_array/sequence/trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(T, Rhs::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>) -> U, </span></code><a class="srclink" href="../../src/generic_array/lib.rs.html#489-498" title="goto source code">[src]</a></h4><h4 id="method.fold-1" class="method hidden"><code>fn <a href="#method.fold-1" class="fnname">fold</a><U, F>(self, init: U, f: F) -> U <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(U, T) -> U, </span></code><a class="srclink" href="../../src/generic_array/lib.rs.html#500-517" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/generic_array/functional/trait.FunctionalSequence.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "generic_array";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |