22 lines
17 KiB
HTML
22 lines
17 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="Defines some sequence with an associated length and iteration capabilities."><title>GenericSequence in generic_array::sequence - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">GenericSequence</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../generic_array/index.html">generic_<wbr>array</a><span class="version">0.14.7</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Generic<wbr>Sequence</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Length" title="Length">Length</a></li><li><a href="#associatedtype.Sequence" title="Sequence">Sequence</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.generate" title="generate">generate</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-GenericSequence%3CT%3E-for-%26S" title="&'a S">&'a S</a></li><li><a href="#impl-GenericSequence%3CT%3E-for-%26mut+S" title="&'a mut S">&'a mut S</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In generic_<wbr>array::<wbr>sequence</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">generic_array</a>::<wbr><a href="index.html">sequence</a></div><h1>Trait <span class="trait">Generic<wbr>Sequence</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/generic_array/sequence.rs.html#12-67">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe trait GenericSequence<T>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> {
|
|
type <a href="#associatedtype.Length" class="associatedtype">Length</a>: <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><T>;
|
|
type <a href="#associatedtype.Sequence" class="associatedtype">Sequence</a>: <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T, Length = Self::<a class="associatedtype" href="trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/iter/traits/collect/trait.FromIterator.html" title="trait core::iter::traits::collect::FromIterator">FromIterator</a><T>;
|
|
|
|
// Required method
|
|
fn <a href="#tymethod.generate" class="fn">generate</a><F>(f: F) -> Self::<a class="associatedtype" href="trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a>
|
|
<span class="where">where F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a>) -> T</span>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Defines some sequence with an associated length and iteration capabilities.</p>
|
|
<p>This is useful for passing N-length generic arrays as generics.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Length" class="method"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#14">Source</a><h4 class="code-header">type <a href="#associatedtype.Length" class="associatedtype">Length</a>: <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><T></h4></section></summary><div class="docblock"><p><code>GenericArray</code> associated length</p>
|
|
</div></details><details class="toggle" open><summary><section id="associatedtype.Sequence" class="method"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#17">Source</a><h4 class="code-header">type <a href="#associatedtype.Sequence" class="associatedtype">Sequence</a>: <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T, Length = Self::<a class="associatedtype" href="trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a>> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/iter/traits/collect/trait.FromIterator.html" title="trait core::iter::traits::collect::FromIterator">FromIterator</a><T></h4></section></summary><div class="docblock"><p>Concrete sequence type used in conjuction with reference implementations of <code>GenericSequence</code></p>
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.generate" class="method"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#23-25">Source</a><h4 class="code-header">fn <a href="#tymethod.generate" class="fn">generate</a><F>(f: F) -> Self::<a class="associatedtype" href="trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a><div class="where">where
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a>) -> T,</div></h4></section></summary><div class="docblock"><p>Initializes a new sequence instance using the given function.</p>
|
|
<p>If the generator function panics while initializing the sequence,
|
|
any already initialized elements will be dropped.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-GenericSequence%3CT%3E-for-%26S" class="impl"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#75-89">Source</a><a href="#impl-GenericSequence%3CT%3E-for-%26S" class="anchor">§</a><h3 class="code-header">impl<'a, T: 'a, S: <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T>> <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&'a S</a><div class="where">where
|
|
<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&'a S</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Length-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#79">Source</a><a href="#associatedtype.Length-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Length" class="associatedtype">Length</a> = <S as <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T>>::<a class="associatedtype" href="trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a></h4></section><section id="associatedtype.Sequence-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#80">Source</a><a href="#associatedtype.Sequence-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Sequence" class="associatedtype">Sequence</a> = <S as <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T>>::<a class="associatedtype" href="trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a></h4></section><section id="method.generate" class="method trait-impl"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#83-88">Source</a><a href="#method.generate" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.generate" class="fn">generate</a><F>(f: F) -> Self::<a class="associatedtype" href="trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a><div class="where">where
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a>) -> T,</div></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-GenericSequence%3CT%3E-for-%26mut+S" class="impl"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#91-105">Source</a><a href="#impl-GenericSequence%3CT%3E-for-%26mut+S" class="anchor">§</a><h3 class="code-header">impl<'a, T: 'a, S: <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T>> <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&'a mut S</a><div class="where">where
|
|
<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&'a mut S</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Length-2" class="associatedtype trait-impl"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#95">Source</a><a href="#associatedtype.Length-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Length" class="associatedtype">Length</a> = <S as <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T>>::<a class="associatedtype" href="trait.GenericSequence.html#associatedtype.Length" title="type generic_array::sequence::GenericSequence::Length">Length</a></h4></section><section id="associatedtype.Sequence-2" class="associatedtype trait-impl"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#96">Source</a><a href="#associatedtype.Sequence-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Sequence" class="associatedtype">Sequence</a> = <S as <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T>>::<a class="associatedtype" href="trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a></h4></section><section id="method.generate-1" class="method trait-impl"><a class="src rightside" href="../../src/generic_array/sequence.rs.html#99-104">Source</a><a href="#method.generate-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.generate" class="fn">generate</a><F>(f: F) -> Self::<a class="associatedtype" href="trait.GenericSequence.html#associatedtype.Sequence" title="type generic_array::sequence::GenericSequence::Sequence">Sequence</a><div class="where">where
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a>) -> T,</div></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-GenericSequence%3CT%3E-for-GenericArray%3CT,+N%3E" class="impl"><a class="src rightside" href="../../src/generic_array/lib.rs.html#372-459">Source</a><a href="#impl-GenericSequence%3CT%3E-for-GenericArray%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, N> <a class="trait" href="trait.GenericSequence.html" title="trait generic_array::sequence::GenericSequence">GenericSequence</a><T> for <a class="struct" href="../struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><T, N><div class="where">where
|
|
N: <a class="trait" href="../trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><T>,
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Length-3" class="associatedtype trait-impl"><a class="src rightside" href="../../src/generic_array/lib.rs.html#377">Source</a><a href="#associatedtype.Length-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Length" class="associatedtype">Length</a> = N</h4></section><section id="associatedtype.Sequence-3" class="associatedtype trait-impl"><a class="src rightside" href="../../src/generic_array/lib.rs.html#378">Source</a><a href="#associatedtype.Sequence-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Sequence" class="associatedtype">Sequence</a> = <a class="struct" href="../struct.GenericArray.html" title="struct generic_array::GenericArray">GenericArray</a><T, N></h4></section></div></details></div><script src="../../trait.impl/generic_array/sequence/trait.GenericSequence.js" async></script></section></div></main></body></html> |