| <!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="`tinyvec` provides 100% safe vec-like data structures."><meta name="keywords" content="rust, rustlang, rust-lang, tinyvec"><title>tinyvec - 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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer 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 mod crate"><!--[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">☰</button><a class="sidebar-logo" href="../tinyvec/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../tinyvec/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate tinyvec</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 1.6.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">tinyvec</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></h1><span class="out-of-band"><a class="srclink" href="../src/tinyvec/lib.rs.html#1-107">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>tinyvec</code> provides 100% safe vec-like data structures.</p> |
| <h3 id="provided-types"><a href="#provided-types">Provided Types</a></h3> |
| <p>With no features enabled, this crate provides the <a href="struct.ArrayVec.html" title="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 <a href="struct.SliceVec.html" title="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 <a href="enum.TinyVec.html" title="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 [<code>Default</code>] trait. This means that this crate isn’t suitable for |
| all situations, but a very surprising number of types do support <code>Default</code>.</p> |
| <h3 id="other-features"><a href="#other-features">Other Features</a></h3> |
| <ul> |
| <li><code>grab_spare_slice</code> lets you get access to the “inactive” portions of an |
| ArrayVec.</li> |
| <li><code>rustc_1_40</code> makes the crate assume a minimum rust version of <code>1.40.0</code>, |
| which allows some better internal optimizations.</li> |
| <li><code>serde</code> provides a <code>Serialize</code> and <code>Deserialize</code> implementation for |
| <a href="enum.TinyVec.html" title="TinyVec"><code>TinyVec</code></a> and <a href="struct.ArrayVec.html" title="ArrayVec"><code>ArrayVec</code></a> types, provided the inner item also has an |
| implementation.</li> |
| </ul> |
| <h3 id="api"><a href="#api">API</a></h3> |
| <p>The general goal of the crate is that, as much as possible, the vecs here |
| should be a “drop in” replacement for the standard library <code>Vec</code> type. We |
| strive to provide all of the <code>Vec</code> methods with the same names and |
| signatures. The exception is that the element type of some methods will have |
| a <code>Default</code> bound that’s not part of the normal <code>Vec</code> type.</p> |
| <p>The vecs here also have a few additional methods that aren’t on the <code>Vec</code> |
| type. In this case, the names tend to be fairly long so that they are |
| unlikely to clash with any future methods added to <code>Vec</code>.</p> |
| <h3 id="stability"><a href="#stability">Stability</a></h3> |
| <ul> |
| <li>The <code>1.0</code> series of the crate works with Rustc <code>1.34.0</code> or later, though |
| you still need to have Rustc <code>1.36.0</code> to use the <code>alloc</code> feature.</li> |
| <li>The <code>2.0</code> version of the crate is planned for some time after the |
| <code>min_const_generics</code> stuff becomes stable. This would greatly raise the |
| minimum rust version and also allow us to totally eliminate the need for |
| the <code>Array</code> trait. The actual usage of the crate is not expected to break |
| significantly in this transition.</li> |
| </ul> |
| </div></details><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.array_vec.html" title="tinyvec::array_vec macro">array_vec</a></div><div class="item-right docblock-short">Helper to make an <code>ArrayVec</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.tiny_vec.html" title="tinyvec::tiny_vec macro">tiny_vec</a></div><div class="item-right docblock-short">Helper to make a <code>TinyVec</code>.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ArrayVec.html" title="tinyvec::ArrayVec struct">ArrayVec</a></div><div class="item-right docblock-short">An array-backed, vector-like data structure.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ArrayVecDrain.html" title="tinyvec::ArrayVecDrain struct">ArrayVecDrain</a></div><div class="item-right docblock-short">Draining iterator for <a href="struct.ArrayVec.html" title="ArrayVec"><code>ArrayVec</code></a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ArrayVecIterator.html" title="tinyvec::ArrayVecIterator struct">ArrayVecIterator</a></div><div class="item-right docblock-short">Iterator for consuming an <code>ArrayVec</code> and returning owned elements.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ArrayVecSplice.html" title="tinyvec::ArrayVecSplice struct">ArrayVecSplice</a></div><div class="item-right docblock-short">Splicing iterator for <code>ArrayVec</code> |
| See <a href="struct.ArrayVec.html#method.splice"><code>ArrayVec::splice</code></a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SliceVec.html" title="tinyvec::SliceVec struct">SliceVec</a></div><div class="item-right docblock-short">A slice-backed vector-like data structure.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SliceVecDrain.html" title="tinyvec::SliceVecDrain struct">SliceVecDrain</a></div><div class="item-right docblock-short">Draining iterator for <a href="struct.SliceVec.html" title="SliceVec"><code>SliceVec</code></a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TinyVecSplice.html" title="tinyvec::TinyVecSplice struct">TinyVecSplice</a></div><div class="item-right docblock-short">Splicing iterator for <code>TinyVec</code> |
| See <a href="enum.TinyVec.html#method.splice"><code>TinyVec::splice</code></a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TryFromSliceError.html" title="tinyvec::TryFromSliceError struct">TryFromSliceError</a></div><div class="item-right docblock-short">The error type returned when a conversion from a slice to an <a href="struct.ArrayVec.html" title="ArrayVec"><code>ArrayVec</code></a> |
| fails.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TinyVec.html" title="tinyvec::TinyVec enum">TinyVec</a></div><div class="item-right docblock-short">A vector that starts inline, but can automatically move to the heap.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TinyVecDrain.html" title="tinyvec::TinyVecDrain enum">TinyVecDrain</a></div><div class="item-right docblock-short">Draining iterator for <code>TinyVecDrain</code></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TinyVecIterator.html" title="tinyvec::TinyVecIterator enum">TinyVecIterator</a></div><div class="item-right docblock-short">Iterator for consuming an <code>TinyVec</code> and returning owned elements.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Array.html" title="tinyvec::Array trait">Array</a></div><div class="item-right docblock-short">A trait for types that are an array.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="tinyvec" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
