Enum Argument

pub enum Argument<'a> {
    Pid(Koid),
    Tid(Koid),
    Tag(Cow<'a, str>),
    Dropped(u64),
    File(Cow<'a, str>),
    Message(Cow<'a, str>),
    Line(u64),
    Other {
        name: Cow<'a, str>,
        value: Value<'a>,
    },
}

An argument of the log record identified by a name and with an associated value.

Variants

Pid(Koid)

Process ID

Tid(Koid)

Thread ID

Tag(Cow<'a, str>)

A log tag

Dropped(u64)

Number of dropped logs

File(Cow<'a, str>)

A filename

Message(Cow<'a, str>)

A log message

Line(u64)

A line number in a file

Other

A custom argument with a given name and value

Fields

name: Cow<'a, str>

The name of the argument.

value: Value<'a>

The value of the argument.

Implementations

impl<'a> Argument<'a>

pub fn new(name: impl Into<Cow<'a, str>>, value: impl Into<Value<'a>>) -> Self

Creates a new argument given its name and a value.

pub fn pid(koid: Koid) -> Self

Creates a new argument for a process id.

pub fn tid(koid: Koid) -> Self

Creates a new argument for a thread id.

pub fn message(message: impl Into<Cow<'a, str>>) -> Self

Creates a new argument for a log message.

pub fn tag(value: impl Into<Cow<'a, str>>) -> Self

Creates a new argument for a tag.

pub fn dropped(value: u64) -> Self

Creates a new argument for the number of dropped logs.

pub fn file(value: impl Into<Cow<'a, str>>) -> Self

Creates a new argument for a file.

pub fn line(value: u64) -> Self

Creates a new argument for a line number.

pub fn other(name: impl Into<Cow<'a, str>>, value: impl Into<Value<'a>>) -> Self

Creates a new key-value argument.

pub fn into_owned(self) -> Argument<'static>

Consumes the current value and returns one in the static lifetime.

pub fn name(&self) -> &str

Returns the name of the argument.

pub fn value(&'a self) -> Value<'a>

Returns the value of the argument.

Trait Implementations

impl<'a> Clone for Argument<'a>

fn clone(&self) -> Argument<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Argument<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Argument<'a>

fn eq(&self, other: &Argument<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<B: MutableBuffer> WriteArgumentValue<B> for Argument<'_>

fn write_value( &self, header: &mut Header, encoder: &mut Encoder<B>, ) -> Result<(), EncodingError>

Writes the value of the argument.

impl<'a> StructuralPartialEq for Argument<'a>