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

#[cfg(feature = "tracy")]
use std::time::Instant;

#[cfg(feature = "tracy")]
use crate::backends::base::TracingBackend;
#[cfg(feature = "tracy")]
use tracy_client;

#[cfg(feature = "tracy")]
use crate::profile_result::ProfileResult;

#[cfg(feature = "tracy")]
pub struct TracyProfiler {
    max_frames: Option<usize>,
    pub frame_count: usize,
    max_duration_ms: Option<u64>,
    start_time: Option<Instant>,
    _client: tracy_client::Client,
}

#[cfg(feature = "tracy")]
impl TracyProfiler {
    pub fn new() -> Self {
        Self {
            max_frames: None,
            frame_count: 0,
            max_duration_ms: None,
            start_time: None,
            _client: tracy_client::Client::start(),
        }
    }
}

#[cfg(feature = "tracy")]
impl TracingBackend for TracyProfiler {
    fn begin_session(&mut self, _name: &str, _filepath: &str) {}

    fn begin_session_limited(
        &mut self,
        _name: &str,
        _filepath: &str,
        max_frames: Option<usize>,
        max_duration_ms: Option<u64>,
    ) {
        self.max_frames = Some(max_frames.unwrap_or(usize::MAX));
        self.max_duration_ms = max_duration_ms;
        self.frame_count = 0;
        self.start_time = Some(Instant::now());
    }

    fn end_session(&mut self) -> Result<(), String> {
        Ok(())
    }

    fn new_frame(&mut self) {
        self.frame_count += 1;

        if let Some(max) = self.max_frames {
            if self.frame_count >= max {
                return;
            }
        }

        if let Some(max_ms) = self.max_duration_ms {
            if let Some(start) = self.start_time {
                if start.elapsed().as_millis() as u64 >= max_ms {
                    return;
                }
            }
        }

        tracy_client::frame_mark();
    }

    fn record_event(&mut self, _event: &ProfileResult) {}

    fn record_span(&mut self, _name: &str) {}
}