fasyslog 1.0.1

A fast syslog client written in Rust.
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

// Copyright 2024 FastLabs Developers
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::borrow::Cow;
use std::io;
use std::io::BufWriter;
use std::net::TcpStream;
use std::net::ToSocketAddrs;

use crate::format::SyslogContext;
use crate::sender::internal::impl_syslog_sender_common;
use crate::sender::internal::impl_syslog_stream_send_formatted;

/// Create a TCP sender that sends messages to the well-known port (601).
///
/// See also [RFC-3195] §9.2 The System (Well-Known) TCP port number for syslog-conn.
///
/// [RFC-3195]: https://datatracker.ietf.org/doc/html/rfc3195#section-9.2
pub fn tcp_well_known() -> io::Result<TcpSender> {
    tcp("127.0.0.1:601")
}

/// Create a TCP sender that sends messages to the given address.
pub fn tcp<A: ToSocketAddrs>(addr: A) -> io::Result<TcpSender> {
    TcpSender::connect(addr)
}

/// A syslog sender that sends messages to a TCP socket.
///
/// Users can obtain a `TcpSender` by calling [`tcp_well_known`] or [`tcp`].
#[derive(Debug)]
pub struct TcpSender {
    writer: BufWriter<TcpStream>,
    context: SyslogContext,
    postfix: Cow<'static, str>,
}

impl TcpSender {
    /// Connect to a TCP socket at the given address.
    pub fn connect<A: ToSocketAddrs>(addr: A) -> io::Result<Self> {
        let stream = TcpStream::connect(addr)?;
        Ok(Self {
            writer: BufWriter::new(stream),
            context: SyslogContext::default(),
            postfix: Cow::Borrowed("\r\n"),
        })
    }

    /// Set the postfix when formatting Syslog message.
    ///
    /// This is generally '\r\n' as defined in [RFC-6587] §3.4.2.
    ///
    /// [RFC-6587]: https://datatracker.ietf.org/doc/html/rfc6587
    pub fn set_postfix(&mut self, postfix: impl Into<Cow<'static, str>>) {
        self.postfix = postfix.into();
    }

    /// Set the context when formatting Syslog message.
    pub fn set_context(mut self, context: SyslogContext) {
        self.context = context;
    }

    /// Mutate the context when formatting Syslog message.
    pub fn mut_context(&mut self) -> &mut SyslogContext {
        &mut self.context
    }
}

impl_syslog_sender_common!(TcpSender);
impl_syslog_stream_send_formatted!(TcpSender);