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

//! Async tracking: async blocks, await, futures

use super::TRACKER;

pub fn track_async_block_enter(
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] block_id: usize,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] location: &str,
) {
    #[cfg(feature = "track")]
    {
        let mut tracker = TRACKER.lock();
        tracker.record_async_block_enter(block_id, location);
    }
}

/// Track async block exit.
///
/// Records an `AsyncBlockExit` event. Use this when exiting an async block.
///
/// # Arguments
///
/// * `block_id` - Identifier matching the corresponding `track_async_block_enter`
/// * `location` - Source location
#[inline(always)]
pub fn track_async_block_exit(
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] block_id: usize,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] location: &str,
) {
    #[cfg(feature = "track")]
    {
        let mut tracker = TRACKER.lock();
        tracker.record_async_block_exit(block_id, location);
    }
}

/// Track await expression start.
///
/// Records an `AwaitStart` event. Use this before awaiting a future.
///
/// # Arguments
///
/// * `await_id` - Unique identifier for this await point
/// * `future_name` - Name or description of the future being awaited
/// * `location` - Source location
#[inline(always)]
pub fn track_await_start(
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] await_id: usize,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] future_name: &str,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] location: &str,
) {
    #[cfg(feature = "track")]
    {
        let mut tracker = TRACKER.lock();
        tracker.record_await_start(await_id, future_name, location);
    }
}

/// Track await expression completion.
///
/// Records an `AwaitEnd` event. Use this after a future completes.
///
/// # Arguments
///
/// * `await_id` - Identifier matching the corresponding `track_await_start`
/// * `location` - Source location
#[inline(always)]
pub fn track_await_end(
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] await_id: usize,
    #[cfg_attr(not(feature = "track"), allow(unused_variables))] location: &str,
) {
    #[cfg(feature = "track")]
    {
        let mut tracker = TRACKER.lock();
        tracker.record_await_end(await_id, location);
    }
}