silly-alloc 0.1.0

A collection of very basic allocators.
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
46
47
48
49
50
51
52

#![no_std]

/*!
`silly_alloc` is a collection of very basic allocators that are fast and small. Written with WebAssembly in mind.

# Features

- Bump allocators — Fast and small allocators that cannot free memory.
- Bucket allocators — Alloctors that excel at frequent allocations and deallocations of a similar size.
- Works with `#![no_std]`
- Support for and tests on `wasm32-unknown-unknown` and `wasm32-wasi`.

# Warning

This crate is young and experimental. I have tried my best to ensure correct functionality through testing, but it’s very likely that there are bugs. It’s even more likely that features are missing that should be there. Please feel free to open issues or even PRs!

# Examples

- [Examples for bump allocators](bump/index.html)
- [Examples for bucket allocators](bucket/index.html)

# Running the tests

To run the unit and integration tests:

```shell
$ cargo test --target=wasm32-wasi
```

To run the doc tests, Nightly Rust is required (as cross-compiling doc tests is still experimental) and a special environment variable needs to be set so that the macro crate generates the correct absolute paths for the bucket allocator types.

```shell
$ SILLY_ALLOC_DOC_TESTS=1 cargo +nightly test --doc --target wasm32-wasi -Zdoctest-xcompile
```

---
License Apache 2.*/

pub mod bump;
pub use bump::BumpAllocator;
pub use bump::SliceBumpAllocator;
#[cfg(target_arch = "wasm32")]
pub use bump::WasmBumpAllocator;

pub mod bucket;

pub use silly_alloc_macros::bucket_allocator;

// Enable std for testing
#[cfg(test)]
#[macro_use]
extern crate std;