deepsize 0.2.0

A crate for measuring the total size of object on the stack and heap
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

use crate::known_deep_size;
use crate::DeepSizeOf;

use alloc::{boxed::Box, string::String, vec};
use core::mem::size_of;

#[test]
fn primitive_types() {
    assert_eq!(0u8.deep_size_of(), 1);
    assert_eq!(0u16.deep_size_of(), 2);
    assert_eq!(0u32.deep_size_of(), 4);
    assert_eq!(0u64.deep_size_of(), 8);
    assert_eq!(0usize.deep_size_of(), size_of::<usize>());

    assert_eq!(0i8.deep_size_of(), 1);
    assert_eq!(0i16.deep_size_of(), 2);
    assert_eq!(0i32.deep_size_of(), 4);
    assert_eq!(0i64.deep_size_of(), 8);
    assert_eq!(0isize.deep_size_of(), size_of::<isize>());

    assert_eq!(0f32.deep_size_of(), 4);
    assert_eq!(0f64.deep_size_of(), 8);

    assert_eq!('f'.deep_size_of(), 4);
    assert_eq!("Hello World!".deep_size_of(), 12);
    assert_eq!((&"Hello World!").deep_size_of(), 16);
    assert_eq!(true.deep_size_of(), 1);
}

#[test]
fn boxes() {
    let boxed = Box::new(0u32);
    assert_eq!(boxed.deep_size_of(), 4 + size_of::<usize>());
}

#[test]
fn arcs() {
    use std::sync::Arc;
    let test: Arc<[u32]> = vec![1, 2, 3].into();
    let multiple = (Arc::clone(&test), Arc::clone(&test), test);

    assert_eq!(
        multiple.deep_size_of(),
        3 * size_of::<Arc<[u32]>>() + 3 * size_of::<u32>()
    );
}

#[test]
fn slices() {
    let array: Box<[u32]> = vec![0; 64].into_boxed_slice();
    assert_eq!(array[5..10].deep_size_of(), 4 * 5);
    assert_eq!(array[..32].deep_size_of(), 4 * 32);
    assert_eq!(
        DeepSizeOf::deep_size_of(&array),
        size_of::<usize>() * 2 + size_of::<[u32; 64]>()
    );
}

// TODO: find edge cases
#[test]
fn alignment() {
    #[repr(align(256))]
    struct Test(u8);
    known_deep_size!(0; Test);

    struct Test2(Test, u8);
    known_deep_size!(0; Test2);

    let array: [Test; 3] = [Test(5), Test(16), Test(2)];
    assert_eq!(size_of::<[Test; 3]>(), array.deep_size_of());

    let vec = vec![Test(5), Test(16), Test(2)];
    assert_eq!(vec.deep_size_of(), 256 * 3 + 24);

    let vec = vec![Test2(Test(5), 0), Test2(Test(16), 0), Test2(Test(2), 0)];
    assert_eq!(vec.deep_size_of(), 512 * 3 + 24);
}

#[test]
fn strings() {
    let string_a = String::from("01234567");
    let string_b = String::from("0123456789012345");

    assert_eq!(string_a.deep_size_of(), size_of::<String>() + 8);
    assert_eq!(string_b.deep_size_of(), size_of::<String>() + 16);
}

#[test]
fn tuples() {
    // Alignment - ######## #.##....
    let non_allocating = (45u64, (), (8u8, 16u16));
    let text = "Hello World";
    let allocating = (Box::new(42u32), String::from(text));

    assert_eq!(
        non_allocating.deep_size_of(),
        size_of::<(u64, (), (u8, u16))>()
    );
    assert_eq!(
        allocating.deep_size_of(),
        size_of::<(Box<()>, String)>() + text.len() + size_of::<u32>()
    );
}

mod context_tests {
    use crate::Context;

    #[test]
    fn context_arc_test() {
        let mut context = Context::new();

        let arc = alloc::sync::Arc::new(15);
        assert_eq!(context.contains_arc(&arc), false);
        context.add_arc(&arc);
        assert_eq!(context.contains_arc(&arc), true);
    }

    #[test]
    fn context_rc_test() {
        let mut context = Context::new();

        let rc = alloc::rc::Rc::new(15);
        assert_eq!(context.contains_rc(&rc), false);
        context.add_rc(&rc);
        assert_eq!(context.contains_rc(&rc), true);
    }
}

#[cfg(feature = "derive")]
mod test_derive {
    use super::*;

    #[test]
    fn test_1() {
        #[derive(DeepSizeOf)]
        struct Example<'a>(&'a u32, &'a u32);

        let number = &42;
        let example = Example(number, number);

        let size = example.deep_size_of();
        // Data past references is not counted
        assert_eq!(size, 2 * size_of::<usize>());
    }

    #[test]
    fn test_enum() {
        #[derive(DeepSizeOf)]
        enum ExampleEnum {
            One,
            Two(),
            Three(u32, Box<u8>),
            Four { name: Box<u32> },
            Five {},
        }

        let variant_one = ExampleEnum::One;
        let variant_two = ExampleEnum::Two();
        let variant_three = ExampleEnum::Three(0, Box::new(255));
        let variant_four = ExampleEnum::Four {
            name: Box::new(65536),
        };
        let variant_five = ExampleEnum::Five {};

        assert_eq!(variant_one.deep_size_of(), size_of::<ExampleEnum>());
        assert_eq!(variant_two.deep_size_of(), size_of::<ExampleEnum>());
        assert_eq!(
            variant_three.deep_size_of(),
            size_of::<ExampleEnum>() + size_of::<u8>()
        );
        assert_eq!(
            variant_four.deep_size_of(),
            size_of::<ExampleEnum>() + size_of::<u32>()
        );
        assert_eq!(variant_five.deep_size_of(), size_of::<ExampleEnum>());
    }
}