trallocator

Crates.iotrallocator
lib.rstrallocator
version0.2.1
sourcesrc
created_at2023-03-14 19:21:06.605788
updated_at2023-11-08 20:52:13.865583
descriptionA no_std lbrary for wrapping an existing allocator and tracking the heap usage.
homepagehttps://github.com/xgroleau/trallocator
repositoryhttps://github.com/xgroleau/trallocator
max_upload_size
id810088
size10,103
Xavier Groleau (xgroleau)

documentation

https://docs.rs/trallocator

README

Trallocator

crates.io documentation

A simple no_std library for wrapping an existing allocator and tracking the heap usage. Main usage is to keep track of the heap usage on embedded systems

Usage

Simply wrap an existing allocator with a Trallocator.

Examples

With another allocator, here we use the system one

extern crate alloc;
extern crate std;
use alloc::vec::Vec;
use std::alloc::System;

use trallocator::Trallocator;

#[global_allocator]
static ALLOCATOR: Trallocator<System> = Trallocator::new(System);
fn main() {
    let init = ALLOCATOR.usage();
    let mut vec: Vec<u8> = Vec::new();
    vec.reserve_exact(32);
    assert_eq!(ALLOCATOR.usage(), init+32);
}

With the allocator API

#![feature(allocator_api)]
extern crate alloc;
extern crate std;
use alloc::vec::Vec;
use std::alloc::System;

use trallocator::Trallocator;

let tralloc: Trallocator<System> = Trallocator::new(System);
assert_eq!(tralloc.usage(), 0);
let mut vec: Vec<u8, _> = Vec::new_in(&tralloc);
vec.reserve_exact(32);
assert_eq!(tralloc.usage(), 32);

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 15

cargo fmt