Struct LoggingConfigBuilder

pub struct LoggingConfigBuilder { /* private fields */ }

Builder for LoggingConfig.

Implementations

impl LoggingConfigBuilder

pub fn console<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Filtering directives that determine tracing levels as described at https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/targets/struct.Targets.html#impl-FromStr

You can override this setting with the -l, –log-level command line parameter.

Example: “info,tor_proto::channel=trace”

pub fn journald<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Filtering directives for the journald logger.

Only takes effect if Arti is built with the journald filter.

pub fn log_sensitive_information(&mut self, value: bool) -> &mut Self

If set to true, we disable safe logging on all logs, and store potentially sensitive information at level info or higher.

This can be useful for debugging, but it increases the value of your logs to an attacker. Do not turn this on in production unless you have a good log rotation mechanism.

pub fn time_granularity(&mut self, value: Duration) -> &mut Self

An approximate granularity with which log times should be displayed.

This value controls every log time that arti outputs; it doesn’t have any effect on times written by other logging programs like journald.

We may round this value up for convenience: For example, if you say “2.5s”, we may treat it as if you had said “3s.”

The default is “1s”, or one second.

pub fn build(&self) -> Result<LoggingConfig, ConfigBuildError>

Builds a new LoggingConfig.

Errors

If a required field has not been initialized.

impl LoggingConfigBuilder

pub fn files(&mut self) -> &mut Vec<LogfileConfigBuilder>

Access the being-built list (resolving default)

If the field has not yet been set or accessed, the default list will be constructed and a mutable reference to the now-defaulted list of builders will be returned.

pub fn set_files(&mut self, list: Vec<LogfileConfigBuilder>)

Set the whole list (overriding the default)

pub fn opt_files(&self) -> &Option<Vec<LogfileConfigBuilder>>

Inspect the being-built list (with default unresolved)

If the list has not yet been set, or accessed, &None is returned.

pub fn opt_files_mut(&mut self) -> &mut Option<Vec<LogfileConfigBuilder>>

Mutably access the being-built list (with default unresolved)

If the list has not yet been set, or accessed, &mut None is returned.

Trait Implementations

impl Builder for LoggingConfigBuilder

type Built = LoggingConfig

The type that this builder constructs

fn build(&self) -> Result<LoggingConfig, ConfigBuildError>

Build into a Built

impl Clone for LoggingConfigBuilder

fn clone(&self) -> LoggingConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoggingConfigBuilder

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

Formats the value using the given formatter.

impl Default for LoggingConfigBuilder

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LoggingConfigBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LoggingConfigBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.