[][src]Crate tinyvec

Programmers can have a little vec, as a treat.

What This Is

This crate provides 100% safe code alternatives to both arrayvec and smallvec.

Being 100% safe means that you have to have some sort of compromise compared to the versions using unsafe. In this case, the compromise is that the element type must implement Default to be usable in these vecs. However, that still allows you to use quite a few types, so I think that you'll find these vecs useful in many cases.

  • ArrayVec is an array-backed vec-like structure with a fixed capacity. If you try to grow the length past the array's capacity it will error or panic (depending on the method used).
  • (alloc feature) TinyVec is an enum that's either an "Inline" ArrayVec or a "Heap" Vec. If it's Inline and you try to grow the ArrayVec beyond its array capacity it will quietly transition into Heap mode and then continue the operation.

Crate Goals

  1. The crate is 100% safe code. Not just a safe API, there are also no unsafe internals. #![forbid(unsafe_code)].
  2. No required dependencies.
    • We might provide optional dependencies for extra functionality (eg: serde compatability).
  3. The intended API is that, as much as possible, these types are essentially a "drop-in" replacement for the standard Vec type.
    • Stable Vec methods that the vecs here also have should be the same general signature.
    • Unstable Vec methods are sometimes provided via a crate feature, but if so they also require a Nightly compiler.
    • Some methods are provided that are not part of the Vec type, such as additional constructor methods. In this case, the names are rather long and whimsical in the hopes that they don't class with any possible future methods of Vec
    • If, in the future, Vec stabilizes a method that clashes with an existing extra method here then we'll simply be forced to release a 2.y.z version. Not the end of the world.
    • Some methods of Vec are simply inappropriate and will not be implemented here. For example, ArrayVec cannot possibly implement from_raw_parts.



Helper to make an ArrayVec.


Helper to make a TinyVec.



An array-backed vector-like data structure.


Draining iterator for ArrayVecDrain


Iterator for consuming an ArrayVec and returning owned elements.


Draining iterator for TinyVecDrain



A vector that starts inline, but can automatically move to the heap.


Iterator for consuming an TinyVec and returning owned elements.



A trait for types that are an array.