Struct Builder

pub struct Builder { /* private fields */ }

A builder for Logger.

Implementations

impl Builder

pub fn additional_field<K, V>(self, key: K, value: V) -> Self

where K: Display, V: Into<Value>,

Adds a persistent additional field to the GELF messages.

pub fn default_short_message<V: ToString>(self, short_message: V) -> Self

Sets the ‘short_message’ field’s default value. Defaults to “null”.

Logger uses the default value for short_message when an event does not specify message or short_message in its fields.

pub fn version<V>(self, version: V) -> Self

where V: ToString,

Sets the GELF version number. Defaults to “1.1”.

pub fn host<V>(self, host: V) -> Self

where V: ToString,

Sets the host field. Defaults to the system’s host name.

pub fn line_numbers(self, value: bool) -> Self

Sets whether line numbers should be logged. Defaults to true.

pub fn file_names(self, value: bool) -> Self

Sets whether file names should be logged. Defaults to true.

pub fn module_paths(self, value: bool) -> Self

Sets whether module paths should be logged. Defaults to true.

pub fn buffer(self, length: usize) -> Self

Sets the buffer length. Defaults to 512.

pub fn connect_udp<A>( self, addr: A, ) -> Result<(Logger, ConnectionHandle<A, UdpConnection>), BuilderError>

where A: ToSocketAddrs + Send + Sync + 'static,

Returns a Logger and its UDP ConnectionHandle.

pub fn connect_tcp<A>( self, addr: A, ) -> Result<(Logger, ConnectionHandle<A, TcpConnection>), BuilderError>

where A: ToSocketAddrs + Send + Sync + 'static,

Returns a Logger and its TCP ConnectionHandle.

pub fn init_udp_with_subscriber<S, A>( self, addr: A, subscriber: S, ) -> Result<ConnectionHandle<A, UdpConnection>, BuilderError>

where S: Subscriber + for<'a> LookupSpan<'a> + Send + Sync + 'static, A: ToSocketAddrs + Send + Sync + 'static,

Initialize logging with a given Subscriber and returns its UDP ConnectionHandle.

pub fn init_tcp_with_subscriber<A, S>( self, addr: A, subscriber: S, ) -> Result<ConnectionHandle<A, TcpConnection>, BuilderError>

where A: ToSocketAddrs + Send + Sync + 'static, S: Subscriber + for<'a> LookupSpan<'a> + Send + Sync + 'static,

Initializes logging with a given Subscriber and returns its TCP ConnectionHandle.

pub fn init_tcp<A>( self, addr: A, ) -> Result<ConnectionHandle<A, TcpConnection>, BuilderError>

where A: ToSocketAddrs + Send + Sync + 'static,

Initializes TCP logging and returns its ConnectionHandle.

pub fn init_udp<A>( self, addr: A, ) -> Result<ConnectionHandle<A, UdpConnection>, BuilderError>

where A: ToSocketAddrs + Send + Sync + 'static,

Initialize UDP logging and returns its ConnectionHandle.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.