spinoso_array/array/
mod.rs

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

spinoso_array/array/
mod.rs
