Struct SingleSyslog 

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

A threal local syslog which is completely lockless! It can be used in signle threaded applications or with the thread_local functionality.

thread_local! 
{
    // Could add pub to make it public to whatever Foo already is public to.
    static SYSLOG: RefCell<SingleSyslog> = 
        RefCell::new(SingleSyslog::openlog_with(Some("test"), 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);

The instances will be completly separated and have own FD.

Generics

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

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

Implementations

impl SingleSyslog

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.

In order to access the syslog API, use the [SyslogApi].

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> SingleSyslog<F, D>

where F: SyslogFormatter, D: SyslogDestination,

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

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

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> SingleSyslog<F, D>

where F: SyslogFormatter, D: SyslogDestination,

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

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

pub fn setlogmask(&mut 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(&mut self) -> SyRes<()>

Closes connection to the syslog server (destination).

pub fn syslog(&mut 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(&mut 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(&mut 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(&mut 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> SingleSyslog<F, D>

where F: SyslogFormatter, D: SyslogDestination,

pub fn get_stream<'t, PRI>( &'t mut self, ) -> SyStream<'t, PRI, D, F, &'t mut 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, D> Debug for SingleSyslog<F, D>

where F: SyslogFormatter + Debug, D: SyslogDestination + Debug,

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

Formats the value using the given formatter.

impl<F: SyslogFormatter, D: SyslogDestination> SyStreamSyslogApi<F, D> for &mut SingleSyslog<F, D>

type SYSLOG<'t> = &'t mut SingleSyslog<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.