borrowscope-runtime 0.1.2

Runtime tracking system for BorrowScope
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

//! MaybeUninit tracking

use super::TRACKER;

pub fn track_maybe_uninit_uninit<T>(
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] name: &str,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] location: &str,
    value: std::mem::MaybeUninit<T>,
) -> std::mem::MaybeUninit<T> {
    #[cfg(feature = "track")]
    {
        let mut tracker = TRACKER.lock();
        tracker.record_maybe_uninit_new(name, false, location);
    }
    value
}

/// Track MaybeUninit::new (initialized)
#[inline(always)]
pub fn track_maybe_uninit_new<T>(
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] name: &str,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] location: &str,
    value: std::mem::MaybeUninit<T>,
) -> std::mem::MaybeUninit<T> {
    #[cfg(feature = "track")]
    {
        let mut tracker = TRACKER.lock();
        tracker.record_maybe_uninit_new(name, true, location);
    }
    value
}

/// Track MaybeUninit::write
#[inline(always)]
pub fn track_maybe_uninit_write<'a, T>(
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] var_id: &str,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] location: &str,
    value: &'a mut T,
) -> &'a mut T {
    #[cfg(feature = "track")]
    {
        let mut tracker = TRACKER.lock();
        tracker.record_maybe_uninit_write(var_id, location);
    }
    value
}

/// Track MaybeUninit::assume_init (unsafe)
#[inline(always)]
pub fn track_maybe_uninit_assume_init<T>(
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] var_id: &str,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] location: &str,
    value: T,
) -> T {
    #[cfg(feature = "track")]
    {
        let mut tracker = TRACKER.lock();
        tracker.record_maybe_uninit_assume_init(var_id, location);
    }
    value
}

/// Track MaybeUninit::assume_init_read (unsafe)
#[inline(always)]
pub fn track_maybe_uninit_assume_init_read<T>(
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] var_id: &str,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] location: &str,
    value: T,
) -> T {
    #[cfg(feature = "track")]
    {
        let mut tracker = TRACKER.lock();
        tracker.record_maybe_uninit_assume_init_read(var_id, location);
    }
    value
}

/// Track MaybeUninit::assume_init_drop (unsafe)
#[inline(always)]
pub fn track_maybe_uninit_assume_init_drop(
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] var_id: &str,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] location: &str,
) {
    #[cfg(feature = "track")]
    {
        let mut tracker = TRACKER.lock();
        tracker.record_maybe_uninit_assume_init_drop(var_id, location);
    }
}