Struct VeilidLogDirective 

pub struct VeilidLogDirective { /* private fields */ }

Changes to the VeilidLayerFilter enabled facilities

Veilid log facilities are string names that can refer to two things:

• The name of a tracing log target
• A tag name which represents a group of tracing log targets

Tags are used to group commonly used log facilities that can all be turned on and off together for ease of debugging.

Veilid log directives are instructions to set a facility to a visibility level in the log output. The format is an extension of the RUST_LOG / EnvFilter format.

• enable: facility=level to enable ‘facility’ with a max level, where level is one of error, warn, info, debug, or trace
• disable: facility=off to disable ‘facility’ in the logs
• default: facility=default to remove the facility from the filter and use whatever defaults exist
• reset: level or off by itself removes all logs facility customizations and resets the base log level for -all- targets including external crates. If you change this level you will turn on or off every log target in the system.
• reset default: default by itself sets the logs to the application-specific default log string, which is customizable on the VeilidTracing or VeilidLayerFilter structs. By default the ‘default’ is all logs turned off.

Log facilities can be combined with a comma, like this:

RUST_LOG="common=info,rpc_message=debug"

Log facility names must follow these validity rules:

• log facility name can not be empty
• first character of log facility name must be ASCII alphanumeric or ‘-’
• characters of log facility name must be ASCII alphanumeric or one of ‘-_:’
• log facility tags follows the same rules as facility names but must start with ‘#’

Some of the defined log tags include:

• #veilid - All of the veilid log targets
• #common - The most commonly useful veilid log targets
• #enabled - The set of currently enabled #veilid log targets (those not VeilidConfigLogLevel::Off)

Implementations

impl VeilidLogDirective

pub fn try_facility_level<S: AsRef<str>>( facility: S, opt_level: Option<VeilidConfigLogLevel>, ) -> VeilidAPIResult<Self>

Set a specific facility or tag to log level

pub fn global_level(opt_level: Option<VeilidConfigLogLevel>) -> Self

Clear all log facility mappings and reset the global log facility level to a specific log level or the default levels if None is specified.

Trait Implementations

impl Clone for VeilidLogDirective

fn clone(&self) -> VeilidLogDirective

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VeilidLogDirective

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VeilidLogDirective

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VeilidLogDirective

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

Formats the value using the given formatter.

impl FromStr for VeilidLogDirective

type Err = VeilidAPIError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl IntoIterator for VeilidLogDirective

type Item = VeilidLogDirective

The type of the elements being iterated over.

type IntoIter = Once<VeilidLogDirective>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for VeilidLogDirective

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&String> for VeilidLogDirective

type Error = VeilidAPIError

The type returned in the event of a conversion error.

fn try_from(value: &String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for VeilidLogDirective

type Error = VeilidAPIError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for VeilidLogDirective

type Error = VeilidAPIError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.