macpepdb 1.1.0

Large peptide database for mass spectrometry
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

// std imports
use std::path::PathBuf;

// 3rd party imports
use anyhow::{bail, Result};
use tokio::fs::File;
use tokio::io::{AsyncWriteExt, BufWriter};
use tokio::spawn;
use tokio::sync::mpsc::Receiver;
use tokio::task::JoinHandle;
use tracing::error;

/// Struct for logging messages to a file
///
pub struct MessageLogger {
    thread_handle: Option<JoinHandle<Result<usize>>>,
}

impl MessageLogger {
    /// Starts logging and writes messages to the given file. Stops when all senders are dropped.
    ///
    /// # Arguments
    /// * `log_file_path` - Path to log file
    /// * `receiver` - Receiver for log messages
    /// * `flush_interval` - Number of messages after the file is flushed
    ///
    pub async fn new<T>(
        log_file_path: PathBuf,
        receiver: Receiver<T>,
        flush_interval: usize,
    ) -> Self
    where
        T: ToLogMessage + 'static,
    {
        let thread_handle = spawn(Self::log(log_file_path, receiver, flush_interval));

        Self {
            thread_handle: Some(thread_handle),
        }
    }

    /// Logs the messages
    ///
    /// # Arguments
    /// * `log_file_path` - Path to log file
    /// * `receiver` - Receiver for log messages
    /// * `flush_interval` - Number of messages after the file is flushed
    ///
    async fn log<T>(
        log_file_path: PathBuf,
        mut receiver: Receiver<T>,
        flush_interval: usize,
    ) -> Result<usize>
    where
        T: ToLogMessage,
    {
        let mut message_counter = 0;
        if !log_file_path.exists() {
            File::create(&log_file_path).await?;
        }

        let mut log_file = BufWriter::new(File::create(log_file_path).await?);
        while let Some(message) = receiver.recv().await {
            let bytes = match message.to_message() {
                Ok(bytes) => bytes,
                Err(e) => {
                    error!("Could not convert message to bytes: {:?}", e);
                    continue;
                }
            };
            log_file.write_all(&bytes).await?;
            log_file.write_all(b"\n").await?;
            message_counter += 1;
            if message_counter % flush_interval == 0 {
                log_file.flush().await?;
            }
        }

        log_file.flush().await?;
        Ok(message_counter)
    }

    /// Stops the logger and returns the number of messages logged
    ///
    pub async fn stop(&mut self) -> Result<usize> {
        match self.thread_handle.take() {
            Some(handle) => Ok(handle.await??),
            None => bail!("Logger already stopped"),
        }
    }
}

/// Trait for converting a type to a log message
pub trait ToLogMessage: Sync + Send {
    fn to_message(&self) -> Result<Vec<u8>>;
}

/// Implementations of ToLogMessage for standard String
///
impl ToLogMessage for String {
    fn to_message(&self) -> Result<Vec<u8>> {
        Ok(self.as_bytes().to_vec())
    }
}

/// Implementations of ToLogMessage for standard anyhow::Error
///
impl ToLogMessage for anyhow::Error {
    fn to_message(&self) -> Result<Vec<u8>> {
        Ok(format!("{:?}", self).as_bytes().to_vec())
    }
}