timetrace 0.2.2

Lightweight Rust profiling library with RAII and Chrome/Perfetto trace support
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

use serde::{Deserialize, Serialize};

// =======================================================
// =======================================================
// Profile Result Builder
// =======================================================
// =======================================================

pub struct ProfileResultBuilder {
    name: String,
    cat: String,
    ph: String,
    ts: u64,
    dur: u64,
    pid: u64,
    tid: u64,
    args: Option<serde_json::Value>,
}

impl ProfileResultBuilder {
    pub fn with_name(mut self, name: String) -> Self {
        self.name = name;
        self
    }

    pub fn with_cat(mut self, cat: String) -> Self {
        self.cat = cat;
        self
    }

    pub fn with_ph(mut self, ph: String) -> Self {
        self.ph = ph;
        self
    }

    pub fn with_ts(mut self, ts: u64) -> Self {
        self.ts = ts;
        self
    }

    pub fn with_dur(mut self, dur: u64) -> Self {
        self.dur = dur;
        self
    }

    pub fn with_pid(mut self, pid: u64) -> Self {
        self.pid = pid;
        self
    }

    pub fn with_tid(mut self, tid: u64) -> Self {
        self.tid = tid;
        self
    }

    pub fn args(mut self, args: Option<serde_json::Value>) -> Self {
        self.args = args;
        self
    }

    pub fn build(self) -> ProfileResult {
        ProfileResult {
            name: self.name,
            cat: self.cat,
            ph: self.ph,
            ts: self.ts,
            dur: self.dur,
            pid: self.pid,
            tid: self.tid,
            args: self.args,
        }
    }
}

impl Default for ProfileResultBuilder {
    fn default() -> Self {
        Self {
            name: "Unnamed".into(),
            cat: "function".into(),
            ph: "X".into(),
            ts: 0,
            dur: 0,
            pid: 0,
            tid: 0,
            args: None,
        }
    }
}

// =======================================================
// =======================================================
// Profile Result
// =======================================================
// =======================================================

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ProfileResult {
    pub name: String,
    pub cat: String,
    pub ph: String,
    pub ts: u64,
    pub dur: u64,
    pub pid: u64,
    pub tid: u64,
    pub args: Option<serde_json::Value>,
}

impl ProfileResult {
    pub fn complete(name: impl Into<String>, ts: u64, dur: u64, tid: u64, pid: u64) -> Self {
        Self {
            name: name.into(),
            cat: "function".into(),
            ph: "X".into(),
            ts,
            dur,
            pid,
            tid,
            args: None,
        }
    }
}