spinoso_array/array/
mod.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// Implementations of Ruby [`Array`], a growable vector.
//
// This module contains multiple implementations of a backing store for the
// Ruby `Array` core class. [`Array`](vec::Array) is based on the [`Vec`] type
// in `std`. [`SmallArray`](smallvec::SmallArray) is based on [`SmallVec`].
// [`TinyArray`](tinyvec::TinyArray) is based on [`TinyVec`].
//
// The smallvec backend uses small vector optimization to store
// [some elements][inline-capacity] inline without spilling to the heap.
//
// The `SmallArray` backend requires the `small-array` Cargo feature to be
// enabled.
//
// [`Array`]: https://ruby-doc.org/core-3.1.2/Array.html
// [`Vec`]: alloc::vec::Vec
// [`SmallVec`]: ::smallvec::SmallVec
// [`TinyVec`]: ::tinyvec::TinyVec
// [inline-capacity]: INLINE_CAPACITY

#[cfg(feature = "small-array")]
pub mod smallvec;
#[cfg(feature = "tiny-array")]
pub mod tinyvec;
pub mod vec;

/// Vectors that implement the small vector optimization can store 8 elements
/// inline without a heap allocation.
#[cfg(any(feature = "small-array", feature = "tiny-array"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "small-array", feature = "tiny-array"))))]
pub const INLINE_CAPACITY: usize = 8;