Struct ContextValue

pub struct ContextValue(/* private fields */);

Represents a type of value that can be stored in the log context.

The ContextValue type is a flexible container designed to hold various kinds of data that can be associated with a log entry. It supports primitive types, strings, and more complex types such as those implementing std::fmt::Debug, std::fmt::Display, std::error::Error, or serde::Serialize.

This allows for rich and structured logging, enabling developers to attach meaningful context to log messages.

Examples

use context_logger::ContextValue;

let value = ContextValue::display("example string");
let number = ContextValue::from(42);
let debug_value = ContextValue::debug(vec![1, 2, 3]);

Implementations

impl ContextValue

pub fn null() -> Self

Creates a null context value.

pub fn serde<S>(value: S) -> Self

where S: Serialize + Send + Sync + 'static,

Creates a context value from a serde::Serialize.

pub fn display<T>(value: T) -> Self

where T: Display + Send + Sync + 'static,

Creates a context value from a std::fmt::Display.

pub fn debug<T>(value: T) -> Self

where T: Debug + Send + Sync + 'static,

Creates a context value from a std::fmt::Debug.

pub fn error<T>(value: T) -> Self

where T: Error + Send + Sync + 'static,

Creates a context value from a std::error::Error.

pub fn as_log_value(&self) -> Value<'_>

Represents a context value that can be used with the log crate.

Trait Implementations

impl Debug for ContextValue

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

Formats the value using the given formatter.

impl Display for ContextValue

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

Formats the value using the given formatter.

impl From<&str> for ContextValue

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Cow<'_, str>> for ContextValue

fn from(value: Cow<'_, str>) -> Self

Converts to this type from the input type.

impl From<String> for ContextValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<bool> for ContextValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<char> for ContextValue

fn from(value: char) -> Self

Converts to this type from the input type.

impl From<f64> for ContextValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i128> for ContextValue

fn from(value: i128) -> Self

Converts to this type from the input type.

impl From<i16> for ContextValue

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for ContextValue

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for ContextValue

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for ContextValue

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u128> for ContextValue

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u16> for ContextValue

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for ContextValue

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for ContextValue

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for ContextValue

fn from(value: u8) -> Self

Converts to this type from the input type.