slimvec 0.4.9

Dynamic array with a smaller inline-size
Documentation 
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

`SlimVec` is a dynamic-array containing a generic element type, mirroring the
api of the Standard Library's `Vec` with a smaller inline stack size.

`SlimVec` stores its *length* & *capacity* alongside the buffer on the heap, as
illustrated:

```text
  SlimVec<T>            Allocation
+-------------+       +-------------+
| ptr: 0xabcd | ----> | length:   2 |
+-------------+       |-------------|
                      | capacity: 4 |
                      |=============|
                      | 0:        A |
                      |-------------|
                      | 1:        B |
                      |-------------|
                      | 2: <uninit> |
                      |-------------|
                      | 3: <uninit> |
                      +-------------+
```

An empty `SlimVec` may be created using `SlimVec::new()`, and like `Vec` it
will not allocate until elements are inserted or capacity is explicity
reserved. `SlimVec::new` is also a `const fn`.

```rust
use slimvec::SlimVec;
let mut v = SlimVec::new(); // Has not allocated yet
v.push(8); // Allocates when pushing the first element
```

The `slimvec!` macro may be used to create & populate a `SlimVec` using the
same syntax as the Standard Library's `vec!` macro:
```rust
use slimvec::slimvec;
slimvec![1f32; 5];
slimvec![1usize, 2, 3, 4, 5];
```

`SlimVec<T>` dereferences to `[T]`, so all slice methods are freely available.
This includes utilities such as sorting, searching, and iteration.

`slimvec` support `no_std` environments but `alloc` is required.