#derive #proc-macro

macro datasize_derive

Derive macros for the datasize crate

17 releases

0.2.15 Sep 11, 2023
0.2.14 Mar 8, 2023
0.2.13 Dec 27, 2022
0.2.11 Nov 4, 2022
0.2.3 Nov 18, 2020

#1247 in Procedural macros

Download history 2364/week @ 2023-10-18 1911/week @ 2023-10-25 1946/week @ 2023-11-01 2031/week @ 2023-11-08 2086/week @ 2023-11-15 2329/week @ 2023-11-22 2666/week @ 2023-11-29 2111/week @ 2023-12-06 2253/week @ 2023-12-13 2447/week @ 2023-12-20 1812/week @ 2023-12-27 2091/week @ 2024-01-03 2615/week @ 2024-01-10 2532/week @ 2024-01-17 2069/week @ 2024-01-24 2186/week @ 2024-01-31

9,877 downloads per month
Used in 32 crates (via datasize)

MIT/Apache

21KB
414 lines

data_size::<T>(&T)

The datasize crate is used for for estimating the heap memory usage of values, e.g. the number of bytes used by a Vec outside its on-stack size determined by mem::size_of.

datasize is intended for rough benchmarks, typically to find memory hogs (it won't find memory leaks, as memory that is not reachable will not be reported). While it may not give entirely accurate readings in all situations, it will quickly identify low-hanging fruit.

Example

The DataSize trait is implemented for many primitive and std types, and can be derived for structs and others:

use datasize::DataSize;

#[derive(DataSize)]
struct Example {
    count: usize,
    my_data: Vec<MyStruct>,
    warning: Option<Box<u32>>,
    #[data_size(skip)]
    skipped: Box<char>,
}

Any instance ex of the Example can now report an estimate of its heap allocation through data_size(&ex).

Other works

Other crates suitable for this task are heapsize and malloc_size_of. Unfortunately the heapsize crate has been discontinued and the malloc_size_of crate puts some rather heavy constraints on what allocator can be used.


lib.rs:

Proc-macro DataSize derive for use with the datasize crate.

Dependencies

~1.5MB
~33K SLoC