11 releases (2 stable)

✓ Uses Rust 2018 edition

1.0.1 Jan 1, 2019
1.0.0 Dec 15, 2018
0.7.1 Dec 4, 2018
0.7.0 Nov 19, 2018

#12 in Profiling

Download history 30/week @ 2018-10-17 6/week @ 2018-10-24 3/week @ 2018-10-31 21/week @ 2018-11-07 17/week @ 2018-11-14 46/week @ 2018-11-21 16/week @ 2018-11-28 79/week @ 2018-12-05 14/week @ 2018-12-12 21/week @ 2018-12-19 73/week @ 2018-12-26 12/week @ 2019-01-02

115 downloads per month

Apache-2.0

15KB
147 lines

qadapt

crates.io docs.rs codecov travisci appveyor


debug_assert! for your memory usage

This allocator is a helper for writing high-performance code that is memory-sensitive; a thread panic will be triggered if a function annotated with #[no_alloc], or code inside an assert_no_alloc! macro interacts with the allocator in any way. Wanton allocations and unforeseen drops no more - this library lets you focus on writing code without worrying if Rust properly managed to inline the variable into the stack.

Now, an allocator blowing up in production is a scary thought; that's why QADAPT is designed to strip its own code out whenever you're running with a release build. Just like the debug_assert! macro in Rust's standard library, it's safe to use without worrying about a unforeseen circumstance causing your application to crash.

Usage

Actually making use of QADAPT is straight-forward. To set up the allocator, place the following snippet in either your program binaries (main.rs) or tests:

use qadapt::QADAPT;

#[global_allocator]
static Q: QADAPT = QADAPT;

After that, there are two ways of telling QADAPT that it should trigger a panic:

  1. Annotate functions with the #[no_alloc] proc macro:
use qadapt::no_alloc;

// This function is fine, there are no allocations here
#[no_alloc]
fn do_math() -> u8 {
    2 + 2
}

// This function will trigger a panic when called
#[no_alloc]
fn does_panic() -> Box<u32> {
    Box::new(5)
}

fn main() {
    do_math();
    does_panic();
}
  1. Evaluate expressions with the assert_no_alloc! macro
use qadapt::assert_no_alloc;

fn do_work() {
    // This code is allowed to trigger an allocation
    let b = Box::new(8);
    
    // This code would panic if an allocation occurred inside it
    let x = assert_no_alloc!(*b + 2);
    assert_eq!(x, 10);
}

Dependencies

~555KB