Struct QueuedSyslog 

pub struct QueuedSyslog<S = DefaultQueueAdapter, F = DefaultSyslogFormatter, D = DefaultLocalSyslogDestination>
where
    F: SyslogFormatter,
    D: SyslogDestination,
    S: SyslogQueueChannel<F, D>,
{ /* private fields */ }

A parallel, shared instance of the syslog client which is running in the separate thread and uses a crossbeam channel to receive the messages from the program. It is also capable to combine sync and async i.e sync code and async code is writing to the same syslog connection.

For this isntance a [SyslogApi] and [SyStreamApi] are implemented.

Also if async is enabled, a [AsyncSyslogQueueApi] is implemented.

let log = 
    QueuedSyslog::openlog(
        Some("test1"), 
        LogStat::LOG_CONS | LogStat::LOG_NDELAY | LogStat::LOG_PID, 
        LogFacility::LOG_DAEMON,
        SyslogLocal::new()
    );

let log = 
    QueuedSyslog
        ::<DefaultQueueAdapter, DefaultSyslogFormatter, SyslogLocal>
        ::openlog_with(
            Some("test1"), 
            LogStat::LOG_CONS | LogStat::LOG_NDELAY | LogStat::LOG_PID, 
            LogFacility::LOG_DAEMON,
            SyslogLocal::new()
        );

pub static SYSLOG3: LazyLock<SyncSyslog<DefaultSyslogFormatter, SyslogLocal,>> = 
    LazyLock::new(|| 
        {
            QueuedSyslog
                ::<DefaultQueueAdapter, DefaultSyslogFormatter, SyslogLocal>
                ::openlog_with(
                    Some("test1"), 
                    LogStat::LOG_CONS | LogStat::LOG_NDELAY | LogStat::LOG_PID, 
                    LogFacility::LOG_DAEMON,
                    SyslogLocal::new()
                )
                .unwrap()
        }
    );

A stream is availble via [SyStreamApi].

let _ = write!(SYSLOG.stream(Priority::LOG_DEBUG), "test {} 123 stream test ", d);

Generics

• S - a SyslogQueueChannel a MPSC provider.

• F - a SyslogFormatter which sets the instance which would format the message.

• D - a SyslogDestination instance which is either: [SyslogLocal], [SyslogFile], [SyslogNet], [SyslogTls]. By default a SyslogLocal is selected.

Implementations

impl QueuedSyslog

pub fn openlog( ident: Option<&str>, logstat: LogStat, facility: LogFacility, net_tap_prov: DefaultLocalSyslogDestination, ) -> SyRes<Self>

Opens a default connection to the local syslog server with default formatter with formatter SyslogFormatter and destination [SyslogLocal].

Arguments

• ident - A program name which will appear on the logs. If none, will be determined automatically.

• logstat - LogStat an instance config.

• facility - LogFacility a syslog facility.

• net_tap_prov - a [SyslogLocal] instance with configuration.

Returns

A SyRes is returned (Result) with:

• Result::Ok - with instance

• Result::Err - with error description.

impl<F, D, S> QueuedSyslog<S, F, D>

where F: SyslogFormatter, D: SyslogDestination, S: SyslogQueueChannel<F, D>,

pub fn openlog_with( ident: Option<&str>, logstat: LogStat, facility: LogFacility, net_tap_prov: D, ) -> SyRes<QueuedSyslog<S, F, D>>

Opens a default connection to the local syslog server with default formatter with provided generics.

Arguments

• ident - A program name which will appear on the logs. If none, will be determined automatically.

• logstat - LogStat an instance config.

• facility - LogFacility a syslog facility.

• net_tap_prov - a [SyslogLocal] instance with configuration.

Returns

A SyRes is returned (Result) with:

• Result::Ok - with instance

• Result::Err - with error description.

impl<F: SyslogFormatter, D: SyslogDestination, S: SyslogQueueChannel<F, D>> QueuedSyslog<S, F, D>

pub fn connectlog(&self) -> SyRes<()>

Connects the current instance to the syslog server (destination).

pub fn setlogmask(&self, logmask: i32) -> SyRes<i32>

Sets the logmask to filter out the syslog calls.

See macroses [LOG_MASK] and [LOG_UPTO] to generate mask

Example

LOG_MASK!(Priority::LOG_EMERG) | LOG_MASK!(Priority::LOG_ERROR)

or

~(LOG_MASK!(Priority::LOG_INFO)) LOG_UPTO!(Priority::LOG_ERROR)

pub fn closelog(&self) -> SyRes<()>

Closes connection to the syslog server (destination).

pub fn syslog(&self, pri: Priority, fmt: F) -> SyRes<()>

Similar to libc, syslog() sends data to syslog server.

Arguments

• pri - a priority Priority

• fmt - a formatter SyslogFormatter message. In C exists a functions with variable argumets amount. In Rust you should create your own macros like format!() or use format!()]. The String and ref 'static str can be passed directly.

Returns

A SyRes is returned which may describe an error.

pub fn change_identity(&self, ident: Option<&str>) -> SyRes<()>

This function can be used to update the facility name, for example after fork().

Arguments

• ident - an Option optional new identity (up to 48 UTF8 chars) If set to Option::None would request the program name from OS.

pub fn reconnect(&self) -> SyRes<()>

Re-opens the connection to the syslog server. Can be used to rotate logs(handle SIGHUP).

Returns

A Result is retured as SyRes.

• Result::Ok - with empty inner type.

• Result::Err - an error code and description

pub fn update_tap_data(&self, tap_data: D) -> SyRes<()>

Updates the instance’s socket. tap_data [TapTypeData] should be of the same variant (type) as current.

impl<F, D, S> QueuedSyslog<S, F, D>

where F: SyslogFormatter, D: SyslogDestination, S: SyslogQueueChannel<F, D>,

pub fn get_stream<'t, PRI>(&'t self) -> SyStream<'t, PRI, D, F, &'t Self>

where PRI: SyStreamPri,

Returns the streamable SyStream instance which can be used with write!.

It implements both std::fmt::Write and std::io::Write.

Example

let log = 
    SingleSyslog::openlog(
        Some("test1"), 
        LogStat::LOG_CONS | LogStat::LOG_NDELAY | LogStat::LOG_PID, 
        LogFacility::LOG_DAEMON,
        SyslogLocal::new()
    ).unwrap();
 
write!(log.get_stream::<SyStreamPriDebug>(), "test stream singlesyslog {}", i).unwrap();

Trait Implementations

impl<F: SyslogFormatter, D: SyslogDestination, S: SyslogQueueChannel<F, D>> AsyncSyslogQueueApi<F, D> for QueuedSyslog<S, F, D>

async fn a_setlogmask(&self, logmask: i32) -> SyRes<i32>

Sets the logmask to filter out the syslog calls. This function behaves differently as it behaves in syslog_sync.rs or syslog_async.rs. It may return an error if: syslog thread had exit and some thread calls this function. Or something happened with channel. This function blocks until the previous mask is received.

See macroses [LOG_MASK] and [LOG_UPTO] to generate mask

Example

LOG_MASK!(Priority::LOG_EMERG) | LOG_MASK!(Priority::LOG_ERROR)

or

~(LOG_MASK!(Priority::LOG_INFO)) LOG_UPTO!(Priority::LOG_ERROR)

async fn a_closelog(&self) -> SyRes<()>

Closes connection to the syslog server

async fn a_syslog(&self, pri: Priority, fmt: F) -> SyRes<()>

Similar to libc, syslog() sends data to syslog server, but asynchroniously.

Arguments

• pri - a priority Priority

• fmt - a program’s message to be sent as payload. The message is encoded with the SyslogFormatter and may be different for different formatters.

async fn a_reconnect(&self) -> SyRes<()>

Performs the reconnection to the syslog server or file re-open.

Returns

A Result is retured as SyRes.

• Result::Ok - with empty inner type.

• Result::Err - an error code and description

async fn a_update_tap_data(&self, new_tap: D) -> SyRes<()>

Updates the inner instance destionation i.e path to file or server address. The type of destination can not be changed.

This function disconnects from syslog server if previously was connected (and reconnects if was connected previously).

Arguments

• new_tap - a consumed instance of type D SyslogDestination

Returns

A SyRes is returned. An error may be returned if:

• connection to server was failed

• incorrect type

• disconnect frm server failed

async fn a_connectlog(&mut self) -> SyRes<()>

Requests to connect to remote server.

async fn a_change_identity(&self, ident: &str) -> SyRes<()>

This function can be used to update the facility name, for example after fork().

impl<S, F, D> Clone for QueuedSyslog<S, F, D>

where F: SyslogFormatter + Clone, D: SyslogDestination + Clone, S: SyslogQueueChannel<F, D> + Clone, S::ChannelSnd: Clone,

fn clone(&self) -> QueuedSyslog<S, F, D>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S, F, D> Debug for QueuedSyslog<S, F, D>

where F: SyslogFormatter + Debug, D: SyslogDestination + Debug, S: SyslogQueueChannel<F, D> + Debug, S::ChannelSnd: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F, D, S> Drop for QueuedSyslog<S, F, D>

where F: SyslogFormatter, D: SyslogDestination, S: SyslogQueueChannel<F, D>,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<F, D, S> Send for QueuedSyslog<S, F, D>

where F: SyslogFormatter, D: SyslogDestination, S: SyslogQueueChannel<F, D>,

impl<F, D, S> SyStreamSyslogApi<F, D> for &QueuedSyslog<S, F, D>

where F: SyslogFormatter, D: SyslogDestination, S: SyslogQueueChannel<F, D>,

type SYSLOG<'t> = &'t QueuedSyslog<S, F, D>

A type which declared wither syslog instance can be mutable or not.

fn syslog<'t>(syslog: Self::SYSLOG<'t>, pri: Priority, fmt: F) -> SyRes<()>

Sends message to syslog server over channel.