Debian Codegraph @

.cargo/vendor/tinyvec/README.md

raw
1 [![License:Zlib](https://img.shields.io/badge/License-Zlib-brightgreen.svg)](https://opensource.org/licenses/Zlib)
2 ![Minimum Rust Version](https://img.shields.io/badge/Min%20Rust-1.34-green.svg)
3 [![crates.io](https://img.shields.io/crates/v/tinyvec.svg)](https://crates.io/crates/tinyvec)
4 [![docs.rs](https://docs.rs/tinyvec/badge.svg)](https://docs.rs/tinyvec/)
5
6 ![Unsafe-Zero-Percent](https://img.shields.io/badge/Unsafety-0%25-brightgreen.svg)
7
8 # tinyvec
9
10 A 100% safe crate of vec-like types. `#![forbid(unsafe_code)]`
11
12 Main types are as follows:
13 * `ArrayVec` is an array-backed vec-like data structure. It panics on overflow.
14 * `SliceVec` is the same deal, but using a `&mut [T]`.
15 * `TinyVec` (`alloc` feature) is an enum that's either an `Inline(ArrayVec)` or a `Heap(Vec)`. If a `TinyVec` is `Inline` and would overflow it automatically transitions to `Heap` and continues whatever it was doing.
16
17 To attain this "100% safe code" status there is one compromise: the element type of the vecs must implement `Default`.
18
19 For more details, please see [the docs.rs documentation](https://docs.rs/tinyvec/)