edlang/tinyvec/trait.Array.html

37 lines
115 KiB
HTML
Raw Normal View History

<!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="A trait for types that are an array."><title>Array in tinyvec - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="tinyvec" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-04d5337699b92874.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../tinyvec/index.html">tinyvec</a><span class="version">1.6.0</span></h2></div><h2 class="location"><a href="#">Array</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.Item">Item</a></li></ul><h3><a href="#required-associated-consts">Required Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.CAPACITY">CAPACITY</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.as_slice">as_slice</a></li><li><a href="#tymethod.as_slice_mut">as_slice_mut</a></li><li><a href="#tymethod.default">default</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Array-for-%5BT;+0%5D">[T; 0]</a></li><li><a href="#impl-Array-for-%5BT;+1024%5D">[T; 1024]</a></li><li><a href="#impl-Array-for-%5BT;+10%5D">[T; 10]</a></li><li><a href="#impl-Array-for-%5BT;+11%5D">[T; 11]</a></li><li><a href="#impl-Array-for-%5BT;+128%5D">[T; 128]</a></li><li><a href="#impl-Array-for-%5BT;+12%5D">[T; 12]</a></li><li><a href="#impl-Array-for-%5BT;+13%5D">[T; 13]</a></li><li><a href="#impl-Array-for-%5BT;+14%5D">[T; 14]</a></li><li><a href="#impl-Array-for-%5BT;+15%5D">[T; 15]</a></li><li><a href="#impl-Array-for-%5BT;+16%5D">[T; 16]</a></li><li><a href="#impl-Array-for-%5BT;+17%5D">[T; 17]</a></li><li><a href="#impl-Array-for-%5BT;+18%5D">[T; 18]</a></li><li><a href="#impl-Array-for-%5BT;+19%5D">[T; 19]</a></li><li><a href="#impl-Array-for-%5BT;+1%5D">[T; 1]</a></li><li><a href="#impl-Array-for-%5BT;+2048%5D">[T; 2048]</a></li><li><a href="#impl-Array-for-%5BT;+20%5D">[T; 20
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../tinyvec/all.html" title="show sidebar"></a></div><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" tabindex="-1"><a href="../help.html" title="help">?</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-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">tinyvec</a>::<wbr><a class="trait" href="#">Array</a><button id="copy-path" 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="src" href="../src/tinyvec/array.rs.html#19-42">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Array {
type <a href="#associatedtype.Item" class="associatedtype">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>;
const <a href="#associatedconstant.CAPACITY" class="constant">CAPACITY</a>: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/core/primitive.usize.html">usize</a>;
// Required methods
fn <a href="#tymethod.as_slice" class="fn">as_slice</a>(&amp;self) -&gt; &amp;[Self::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type tinyvec::Array::Item">Item</a>];
<span class="item-spacer"></span> fn <a href="#tymethod.as_slice_mut" class="fn">as_slice_mut</a>(&amp;mut self) -&gt; &amp;mut [Self::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type tinyvec::Array::Item">Item</a>];
<span class="item-spacer"></span> fn <a href="#tymethod.default" class="fn">default</a>() -&gt; Self;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait for types that are an array.</p>
<p>An “array”, for our purposes, has the following properties:</p>
<ul>
<li>Owns some number of elements.</li>
<li>The element type can be generic, but must implement <a href="https://doc.rust-lang.org/1.78.0/core/default/trait.Default.html" title="trait core::default::Default"><code>Default</code></a>.</li>
<li>The capacity is fixed at compile time, based on the implementing type.</li>
<li>You can get a shared or mutable slice to the elements.</li>
</ul>
<p>You are generally <strong>not</strong> expected to need to implement this yourself. It is
already implemented for all the major array lengths (<code>0..=32</code> and the powers
of 2 up to 4,096), or for all array lengths with the feature <code>rustc_1_55</code>.</p>
<p><strong>Additional lengths can easily be added upon request.</strong></p>
<h3 id="safety-reminder"><a class="doc-anchor" href="#safety-reminder">§</a>Safety Reminder</h3>
<p>Just a reminder: this trait is 100% safe, which means that <code>unsafe</code> code
<strong>must not</strong> rely on an instance of this trait being correct.</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.Item" class="method"><a class="src rightside" href="../src/tinyvec/array.rs.html#21">source</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a>: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a></h4></section></summary><div class="docblock"><p>The type of the items in the thing.</p>
</div></details></div><h2 id="required-associated-consts" class="section-header">Required Associated Constants<a href="#required-associated-consts" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedconstant.CAPACITY" class="method"><a class="src rightside" href="../src/tinyvec/array.rs.html#24">source</a><h4 class="code-header">const <a href="#associatedconstant.CAPACITY" class="constant">CAPACITY</a>: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>The number of slots in the thing.</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.as_slice" class="method"><a class="src rightside" href="../src/tinyvec/array.rs.html#30">source</a><h4 class="code-header">fn <a href="#tymethod.as_slice" class="fn">as_slice</a>(&amp;self) -&gt; &amp;[Self::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type tinyvec::Array::Item">Item</a>]</h4></section></summary><div class="docblock"><p>Gives a shared slice over the whole thing.</p>
<p>A correct implementation will return a slice with a length equal to the
<code>CAPACITY</code> value.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.as_slice_mut" class="method"><a class="src rightside" href="../src/tinyvec/array.rs.html#36">source</a><h4 class="code-header">fn <a href="#tymethod.as_slice_mut" class="fn">as_slice_mut</a>(&amp;mut self) -&gt; &amp;mut [Self::<a class="associatedtype" href="trait.Array.html#associatedtype.Item" title="type tinyvec::Array::Item">Item</a>]</h4></section></summary><div class="docblock"><p>Gives a unique slice over the whole thing.</p>
<p>A correct implementation will return a slice with a length equal to the
<code>CAPACITY</code> value.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.default" class="method"><a class="src rightside" href="../src/tinyvec/array.rs.html#41">source</a><h4 class="code-header">fn <a href="#tymethod.default" class="fn">default</a>() -&gt; Self</h4></section></summary><div class="docblock"><p>Create a default-initialized instance of ourself, similar to the
<a href="https://doc.rust-lang.org/1.78.0/core/default/trait.Default.html" title="trait core::default::Default"><code>Default</code></a> trait, but implemented for the same range of sizes as
<a href="trait.Array.html" title="trait tinyvec::Array"><code>Array</code></a>.</p>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.78.0/reference/items/traits.html#object-safety">object safe</a>.</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-Array-for-%5BT;+0%5D" class="impl"><a class="src rightside" href="../src/tinyvec/array/generated_impl.rs.html#7-27">source</a><a href="#impl-Array-for-%5BT;+0%5D" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>&gt; <a class="trait" href="trait.Array.html" title="trait tinyvec::Array">Array</a> for <a class="primitive" href="https://doc.rust-lang.org/1.78.0/core/primitive.array.html">[T; 0]</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Item-1" class="associatedtype trait-impl"><a href="#associatedtype.Item-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = T</h4></section><section id="associatedconstant.CAPACITY-1" class="associatedconstant trait-impl"><a class="src rightside" href="../src/tinyvec/array/generated_impl.rs.html#9">source</a><a href="#associatedconstant.CAPACITY-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.CAPACITY" class="constant">CAPACITY</a>: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/core/primitive.usize.html">usize</a> = 0usize</h4></section><section id="method.as_slice" class="method trait-impl"><a class="src rightside" href="../src/tinyvec/array/generated_impl.rs.html#13-15">source</a><a href="#method.as_slice" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.as_slice" class="fn">as_slice</a>(&amp;self) -&gt; &amp;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/core/primitive.slice.html">[T]</a></h4></section><section id="method.as_slice_mut" class="method trait-impl"><a class="src rightside" href="../src/tinyvec/array/generated_impl.rs.html#19-21">source</a><a href="#method.as_slice_mut" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.as_slice_mut" class="fn">as_slice_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="primitive" href="https://doc.rust-lang.org/1.78.0/core/primitive.slice.html">[T]</a></h4></section><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/tinyvec/array/generated_impl.rs.html#24-26">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.default" class="fn">default</a>() -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Array-for-%5BT;+1%5D" class="impl"><a class="src rightside" href="../src/tinyvec/array/generated_impl.rs.html#29-49">source</a><a href="#impl-Array-for-%5BT;+1%5D" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>&gt; <a class="trait" href="trait.Array.html" title="trait tinyvec::Array">Array</a> for <a class="primitive" href="https://doc.rust-lang.org/1.78.0/core/primitive.array.html">[T; 1]</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Item-2" class="associatedtype trait-impl"><a href="#associatedtype.Item-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = T</h4></section><section id="associatedconstant.CAPACITY-2" class="associatedconstant trait-impl"><a class="src rightside" href="../src/tinyvec/array/generated_impl.rs.html#31">source</a><a href="#associatedconstant.CAPACITY-2" class="anchor">§</a><h4 class="code-header">const <a href="