edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-09-19 09:12:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/tinyvec/index.html
edg-l df146223dd deploy: b3bd34a9bb
2024-07-26 09:42:18 +00:00

49 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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."><title>tinyvec - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><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 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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../tinyvec/index.html">tinyvec</a><span class="version">1.8.0</span></h2></div><div class="sidebar-elems"><ul class="block"><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><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">tinyvec</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/tinyvec/lib.rs.html#1-108">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="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 class="doc-anchor" href="#provided-types">§</a>Provided Types</h3>
<p>With no features enabled, this crate provides the <a href="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 <a href="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 <a href="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 <a href="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
all situations, but a very surprising number of types do support <code>Default</code>.</p>
<h3 id="other-features"><a class="doc-anchor" href="#other-features">§</a>Other Features</h3>
<ul>
<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
<a href="enum.TinyVec.html" title="enum tinyvec::TinyVec"><code>TinyVec</code></a> and <a href="struct.ArrayVec.html" title="struct tinyvec::ArrayVec"><code>ArrayVec</code></a> types, provided the inner item also has an
implementation.</li>
</ul>
<h3 id="api"><a class="doc-anchor" href="#api">§</a>API</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 class="doc-anchor" href="#stability">§</a>Stability</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="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.array_vec.html" title="macro tinyvec::array_vec">array_vec</a></div><div class="desc docblock-short">Helper to make an <code>ArrayVec</code>.</div></li><li><div class="item-name"><a class="macro" href="macro.tiny_vec.html" title="macro tinyvec::tiny_vec">tiny_vec</a></div><div class="desc docblock-short">Helper to make a <code>TinyVec</code>.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ArrayVec.html" title="struct tinyvec::ArrayVec">ArrayVec</a></div><div class="desc docblock-short">An array-backed, vector-like data structure.</div></li><li><div class="item-name"><a class="struct" href="struct.ArrayVecDrain.html" title="struct tinyvec::ArrayVecDrain">ArrayVecDrain</a></div><div class="desc docblock-short">Draining iterator for <a href="struct.ArrayVec.html" title="struct tinyvec::ArrayVec"><code>ArrayVec</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.ArrayVecIterator.html" title="struct tinyvec::ArrayVecIterator">ArrayVecIterator</a></div><div class="desc docblock-short">Iterator for consuming an <code>ArrayVec</code> and returning owned elements.</div></li><li><div class="item-name"><a class="struct" href="struct.ArrayVecSplice.html" title="struct tinyvec::ArrayVecSplice">ArrayVecSplice</a></div><div class="desc docblock-short">Splicing iterator for <code>ArrayVec</code>
See <a href="struct.ArrayVec.html#method.splice" title="method tinyvec::ArrayVec::splice"><code>ArrayVec::splice</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.SliceVec.html" title="struct tinyvec::SliceVec">SliceVec</a></div><div class="desc docblock-short">A slice-backed vector-like data structure.</div></li><li><div class="item-name"><a class="struct" href="struct.SliceVecDrain.html" title="struct tinyvec::SliceVecDrain">SliceVecDrain</a></div><div class="desc docblock-short">Draining iterator for <a href="struct.SliceVec.html" title="struct tinyvec::SliceVec"><code>SliceVec</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.TinyVecSplice.html" title="struct tinyvec::TinyVecSplice">TinyVecSplice</a></div><div class="desc docblock-short">Splicing iterator for <code>TinyVec</code>
See <a href="enum.TinyVec.html#method.splice" title="method tinyvec::TinyVec::splice"><code>TinyVec::splice</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.TryFromSliceError.html" title="struct tinyvec::TryFromSliceError">TryFromSliceError</a></div><div class="desc docblock-short">The error type returned when a conversion from a slice to an <a href="struct.ArrayVec.html" title="struct tinyvec::ArrayVec"><code>ArrayVec</code></a>
fails.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.TinyVec.html" title="enum tinyvec::TinyVec">TinyVec</a></div><div class="desc docblock-short">A vector that starts inline, but can automatically move to the heap.</div></li><li><div class="item-name"><a class="enum" href="enum.TinyVecDrain.html" title="enum tinyvec::TinyVecDrain">TinyVecDrain</a></div><div class="desc docblock-short">Draining iterator for <code>TinyVecDrain</code></div></li><li><div class="item-name"><a class="enum" href="enum.TinyVecIterator.html" title="enum tinyvec::TinyVecIterator">TinyVecIterator</a></div><div class="desc docblock-short">Iterator for consuming an <code>TinyVec</code> and returning owned elements.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Array.html" title="trait tinyvec::Array">Array</a></div><div class="desc docblock-short">A trait for types that are an array.</div></li></ul></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink