Struct syslog_rs::sync::syslog_sync_queue::Syslog

pub struct Syslog { /* private fields */ }

A common instance which describes the syslog state

Trait Implementations

impl SyslogExt for Syslog

fn openlog_custom<P>(
    ident: Option<&str>,
    logstat: LogStat,
    facility: LogFacility,
    sock_path: P
) -> SyRes<Self>where
    P: AsRef<Path>,

NON STANDARD FUNCTION

This function acting like openlog() but allows to open connection to the arbitrary object.

Arguments

• @see openlog()

• sock_path - AsRef Path a path to the unix datagram socket

fn change_identity<I: AsRef<str>>(&self, ident: I) -> SyRes<()>

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

Arguments

• ident - a new identity (up to 48 UTF8 chars)

fn make_stream(&self, pri: Priority) -> Box<dyn SyslogStream>

Creates an instance which is implements core::fmt::Write.

Arguments

• pri - a priority Priority (can be updated)

Returns

Error not supported

impl SyslogStd for Syslog

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

As in a libc, this function initializes the syslog instance. The main difference with realization in C is it returns the instance to program used this crate. This structure implements the Send and Sync so it does not require any additional synchonization.

Arguments

• ident - a identification of the sender. If not set, the crate will determine automatically!

• logstat - sets up the syslog behaviour. Use LogStat

• facility - a syslog facility. Use LogFacility

Returns

• A SyRes with instance or Err()

Example

 Syslog::openlog(
       Some("test1"), 
        LogStat::LOG_NDELAY | LogStat::LOG_PID, 
        LogFacility::LOG_DAEMON);

fn 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)

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

Similar to libc, closelog() will close the log

fn syslog(&self, pri: Priority, fmt: String)

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

Arguments

• pri - a priority Priority

• fmt - a string message. In C exists a functions with variable argumets amount. In Rust you should create your own macros like format!() or use format!()

fn vsyslog<S: AsRef<str>>(&self, pri: Priority, fmt: S)

Similar to syslog() and created for the compatability.

impl Send for Syslog

impl Sync for Syslog