#vec #safe #structures #arrayvec #heap #array #default

no-std supply-chain-trust-example-crate-000085

tinyvec provides 100% safe vec-like data structures

1 stable release

new 1.8.0 Nov 4, 2024

#1068 in Data structures

Zlib OR Apache-2.0 OR MIT

330KB
13K SLoC

License:Zlib Minimum Rust Version crates.io docs.rs

Unsafe-Zero-Percent

tinyvec

A 100% safe crate of vec-like types. Not just safe at the public API boundary, fully safe for all internal code too: #![forbid(unsafe_code)]

The provided types are as follows:

  • ArrayVec is an array-backed vec-like data structure. It panics on overflow.
  • SliceVec is similar, but using a &mut [T] as the data backing.
  • TinyVec (alloc feature) is an enum that's either an Inline(ArrayVec) or a Heap(Vec). If a TinyVec is Inline and would overflow its array it automatically transitions to Heap and continues whatever it was doing.

To attain this "100% safe code" status there is one compromise: the element type of the vecs must implement Default.

For more API details, please see the docs.rs documentation

tinyvec Alternatives?

Maybe you don't want to use tinyvec, there's other crates you might use instead!

  • arrayvec is a crate with array-backed structures.
  • smallvec is a crate where the array-backed data can be moved to the heap on overflow.

The main difference is that both of those crates use unsafe code. This mostly allows them to get rid of the Default limitation for elements that tinyvec imposes. The smallvec and arrayvec crates are generally correct, but there's been occasional bugs leading to UB. With tinyvec, any uncaught bugs can't lead to UB, because the crate is safe code all the way through. If you want that absolute level of assurance against UB, use tinyvec.

Dependencies

~195KB