<p>With no features enabled, this crate provides the <ahref="struct.ArrayVec.html"title="struct tinyvec::ArrayVec"><code>ArrayVec</code></a> type, which
is an array-backed storage. You can push values into the array and pop them
out of the array and so on. If the array is made to overflow it will panic.</p>
<p>Similarly, there is also a <ahref="struct.SliceVec.html"title="struct tinyvec::SliceVec"><code>SliceVec</code></a> type available, which is a vec-like
that’s backed by a slice you provide. You can add and remove elements, but
if you overflow the slice it will panic.</p>
<p>With the <code>alloc</code> feature enabled, the crate also has a <ahref="enum.TinyVec.html"title="enum tinyvec::TinyVec"><code>TinyVec</code></a> type.
This is an enum type which is either an <code>Inline(ArrayVec)</code> or a <code>Heap(Vec)</code>.
If a <code>TinyVec</code> is <code>Inline</code> and would overflow it automatically transitions
itself into being <code>Heap</code> mode instead of a panic.</p>
<p>All of this is done with no <code>unsafe</code> code within the crate. Technically the
<code>Vec</code> type from the standard library uses <code>unsafe</code> internally, but <em>this
crate</em> introduces no new <code>unsafe</code> code into your project.</p>
<p>The limitation is that the element type of a vec from this crate must
support the <ahref="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html"title="trait core::default::Default"><code>Default</code></a> trait. This means that this crate isn’t suitable for
<li><code>grab_spare_slice</code> lets you get access to the “inactive” portions of an
ArrayVec.</li>
<li><code>serde</code> provides a <code>Serialize</code> and <code>Deserialize</code> implementation for
<ahref="enum.TinyVec.html"title="enum tinyvec::TinyVec"><code>TinyVec</code></a> and <ahref="struct.ArrayVec.html"title="struct tinyvec::ArrayVec"><code>ArrayVec</code></a> types, provided the inner item also has an
</div></details><h2id="macros"class="section-header">Macros<ahref="#macros"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="macro"href="macro.array_vec.html"title="macro tinyvec::array_vec">array_vec</a></div><divclass="desc docblock-short">Helper to make an <code>ArrayVec</code>.</div></li><li><divclass="item-name"><aclass="macro"href="macro.tiny_vec.html"title="macro tinyvec::tiny_vec">tiny_vec</a></div><divclass="desc docblock-short">Helper to make a <code>TinyVec</code>.</div></li></ul><h2id="structs"class="section-header">Structs<ahref="#structs"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.ArrayVec.html"title="struct tinyvec::ArrayVec">ArrayVec</a></div><divclass="desc docblock-short">An array-backed, vector-like data structure.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ArrayVecDrain.html"title="struct tinyvec::ArrayVecDrain">ArrayVecDrain</a></div><divclass="desc docblock-short">Draining iterator for <ahref="struct.ArrayVec.html"title="struct tinyvec::ArrayVec"><code>ArrayVec</code></a></div></li><li><divclass="item-name"><aclass="struct"href="struct.ArrayVecIterator.html"title="struct tinyvec::ArrayVecIterator">ArrayVecIterator</a></div><divclass="desc docblock-short">Iterator for consuming an <code>ArrayVec</code> and returning owned elements.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ArrayVecSplice.html"title="struct tinyvec::ArrayVecSplice">ArrayVecSplice</a></div><divclass="desc docblock-short">Splicing iterator for <code>ArrayVec</code>
See <ahref="struct.ArrayVec.html#method.splice"title="method tinyvec::ArrayVec::splice"><code>ArrayVec::splice</code></a></div></li><li><divclass="item-name"><aclass="struct"href="struct.SliceVec.html"title="struct tinyvec::SliceVec">SliceVec</a></div><divclass="desc docblock-short">A slice-backed vector-like data structure.</div></li><li><divclass="item-name"><aclass="struct"href="struct.SliceVecDrain.html"title="struct tinyvec::SliceVecDrain">SliceVecDrain</a></div><divclass="desc docblock-short">Draining iterator for <ahref="struct.SliceVec.html"title="struct tinyvec::SliceVec"><code>SliceVec</code></a></div></li><li><divclass="item-name"><aclass="struct"href="struct.TinyVecSplice.html"title="struct tinyvec::TinyVecSplice">TinyVecSplice</a></div><divclass="desc docblock-short">Splicing iterator for <code>TinyVec</code>
See <ahref="enum.TinyVec.html#method.splice"title="method tinyvec::TinyVec::splice"><code>TinyVec::splice</code></a></div></li><li><divclass="item-name"><aclass="struct"href="struct.TryFromSliceError.html"title="struct tinyvec::TryFromSliceError">TryFromSliceError</a></div><divclass="desc docblock-short">The error type returned when a conversion from a slice to an <ahref="struct.ArrayVec.html"title="struct tinyvec::ArrayVec"><code>ArrayVec</code></a>
fails.</div></li></ul><h2id="enums"class="section-header">Enums<ahref="#enums"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.TinyVec.html"title="enum tinyvec::TinyVec">TinyVec</a></div><divclass="desc docblock-short">A vector that starts inline, but can automatically move to the heap.</div></li><li><divclass="item-name"><aclass="enum"href="enum.TinyVecDrain.html"title="enum tinyvec::TinyVecDrain">TinyVecDrain</a></div><divclass="desc docblock-short">Draining iterator for <code>TinyVecDrain</code></div></li><li><divclass="item-name"><aclass="enum"href="enum.TinyVecIterator.html"title="enum tinyvec::TinyVecIterator">TinyVecIterator</a></div><divclass="desc docblock-short">Iterator for consuming an <code>TinyVec</code> and returning owned elements.</div></li></ul><h2id="traits"class="section-header">Traits<ahref="#traits"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="trait"href="trait.Array.html"title="trait tinyvec::Array">Array</a></div><divclass="desc docblock-short">A trait for types that are an array.</div></li></ul></section></div></main></body></html>
