sparkles 0.1.8

Capture execution flow of your Rust application with CPU cycle precision!
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

use std::fs;
use std::fs::File;
use std::io::Write;
use std::path::PathBuf;
use std::sync::Arc;
use std::sync::atomic::AtomicBool;
use log::debug;
use sparkles_core::protocol::packets::PacketType;
use sparkles_core::protocol::sender::{ConfiguredSender, Sender};

pub(crate) struct FileSender {
    file: File
}

#[derive(Debug, Clone)]
pub enum FileSenderConfig {
    /// Filename will be generated automatically in the format of `{dir_name}/%Y-%m-%d_%H-%M-%S.sprk`
    Directory(PathBuf),
    /// 0: Output file name. Will overwrite file if already exists.
    SingleFile(PathBuf),
}

impl Default for FileSenderConfig {
    fn default() -> Self {
        Self::Directory(PathBuf::from("trace"))
    }
}
impl Sender for FileSender {
    fn send_packet(&mut self, packet_type: PacketType, data: &[&[u8]]) {
        self.file.write_all(&packet_type.pattern()).unwrap();
        let full_size = data.iter().fold(0, |prev, sub| prev + sub.len()) as u32;
        let size_bytes = full_size.to_be_bytes();
        self.file.write_all(&size_bytes).unwrap();
        for d in data {
            self.file.write_all(d).unwrap();
        }
    }
    fn with_timestamp_freq_request(self, _timestamp_freq_request: Arc<AtomicBool>) -> Self
    where
        Self: Sized,
    {
        // not applicable
        self
    }
}

impl ConfiguredSender for FileSender {
    type Config = FileSenderConfig;
    fn new(cfg: &Self::Config) -> Option<Self> {
        // Create log file
        match cfg {
            FileSenderConfig::Directory(dir) => {
                if fs::metadata(dir).is_err() {
                    debug!("[sparkles] Creating output directory...");
                    fs::create_dir(dir).ok()?;
                }

                let now = chrono::Local::now();
                let filename = format!("{}/{}.sprk", dir.to_str().unwrap(), now.format("%Y-%m-%d_%H-%M-%S"));
                debug!("[sparkles] Creating output file: {}", filename);
                let file = File::create(filename).ok()?;

                Some(Self {
                    file
                })
            }
            FileSenderConfig::SingleFile(filename) => {
                let file = File::create(filename).ok()?;

                Some(Self {
                    file
                })
            }
        }
    }
}