mt_logger 3.0.2

A low-dependency, multithreaded logging library with a focus on traceability and ease-of-use via macros.
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

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *\
Filename : logger/log_sender.rs

Copyright (C) 2020 CJ McAllister
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software Foundation,
    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA

Purpose:
    This module defines the Log Sender object, used to dispatch messages to
    the Receiver, which will avoid blocking the main thread for logging
    operations.

\* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

use std::sync::mpsc;

use crate::Command;

///////////////////////////////////////////////////////////////////////////////
//  Data Structures
///////////////////////////////////////////////////////////////////////////////

#[derive(Clone, Debug)]
pub struct Sender {
    logger_tx: mpsc::SyncSender<Command>,
}

///////////////////////////////////////////////////////////////////////////////
//  Object Implementation
///////////////////////////////////////////////////////////////////////////////

impl Sender {
    /// Fully-qualified constructor
    pub fn new(logger_tx: mpsc::SyncSender<Command>) -> Self {
        Self { logger_tx }
    }

    /*  *  *  *  *  *  *  *\
     *  Utility Methods   *
    \*  *  *  *  *  *  *  */

    pub fn send_log(&self, logger_cmd: Command) -> Result<(), mpsc::SendError<Command>> {
        self.logger_tx.send(logger_cmd)
    }

    pub fn send_cmd(&self, cmd: Command) -> Result<(), mpsc::SendError<Command>> {
        self.logger_tx.send(cmd)
    }
}