Struct lunatic_log::Metadata

pub struct Metadata { /* private fields */ }

Metadata describing an Event.

All events have the following metadata:

• A [name], represented as a static string.
• A [target], a string that categorizes part of the system where the event or event occurred. The macros default to using the module path where the event or event originated as the target, but it may be overridden.
• A [verbosity level]. This determines how verbose a given event is, and allows enabling or disabling more verbose diagnostics situationally. See the documentation for the Level type for details.
• The names of the [fields] defined by the event.
• Whether the metadata corresponds to a event.

In addition, the following optional metadata describing the source code location where the event originated may be provided:

• The [file name]
• The [line number]
• The [module path]

Implementations

impl Metadata

pub const fn new( name: String, target: String, level: Level, module_path: Option<String>, file: Option<String>, line: Option<u32> ) -> Self

Construct new metadata for a event, with a name, target, level, field names, and optional source code location.

pub fn level(&self) -> &Level

Returns the level of verbosity of the described span or event.

pub fn name(&self) -> &String

Returns the name of the span.

pub fn target(&self) -> &String

Returns a string describing the part of the system where the span or event that this metadata describes occurred.

Typically, this is the module path, but alternate targets may be set when spans or events are constructed.

pub fn module_path(&self) -> Option<&String>

Returns the path to the Rust module where the span occurred, or None if the module path is unknown.

pub fn file(&self) -> Option<&String>

Returns the name of the source code file where the span occurred, or None if the file is unknown

pub fn line(&self) -> Option<u32>

Returns the line number in the source code file where the span occurred, or None if the line number is unknown.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Metadata

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

Serialize this value into the given Serde serializer.