Struct dlog_rs::Builder

pub struct Builder { /* private fields */ }

The builder can be used to more finely configure dlog to best suit your needs.

Examples

#[macro_use]
extern crate log;

use dlog::Builder;

fn main() {
    Builder::new()
        .with_env_api_key("DLOG_API_KEY")
        .with_level(log::Level::Trace)
        .build();

    info!("Hello from Rust!");

    // Flushes all remaining logs when the app exits
    log::logger().flush();
}

Implementations

impl Builder

pub fn new() -> Self

Instantiates a new builder which can be used to configure dlog.

pub fn with_str_api_key(self, api_key: impl Into<String>) -> Self

Injects the API_KEY directly into the builder.

Arguments

• api_key - The dlog API_KEY for this service.

pub fn with_env_api_key(self, env_var: impl Into<String>) -> Self

Injects the API_KEY into the builder by reading it from an environmental variable.

Arguments

• env_var - The name of the environmental variable where this API_KEY is stored

pub fn with_level(self, level: Level) -> Self

Sets the minimum level a log must have to be logged to dlog.

Arguments

• level - The minimum required log level

pub fn with_email_sanitizer(self) -> Self

Adds the a email sanitizer which tries to remove all email addresses from the log messages. This is a best effort sanitizer and there is no guarantee the it will catch 100% of all valid email addresses.

pub fn with_credit_card_sanitizer(self) -> Self

Adds the a credit card sanitizer which tries to remove all credit card number from the log messages. This is a best effort sanitizer and there is no guarantee the it will catch 100% of all credit card formats.

pub fn build(self)

Consumes the builder and configures dlog according to the builders configuration.

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.