Skip to main content

ErrorMetadata

Struct ErrorMetadata 

Source
pub struct ErrorMetadata { /* private fields */ }
Expand description

Typed structured metadata attached to an error context.

Unlike the ContextRecord trait (whose entries appear in the error’s Display output), metadata stored here is not visible in terminal output. It is intended for programmatic consumers: serialization, snapshots, structured logs, and API responses.

Supports String, bool, i64, and u64 values via MetadataValue.

Implementations§

Source§

impl ErrorMetadata

Source

pub fn new() -> Self

Source

pub fn is_empty(&self) -> bool

Source

pub fn as_map(&self) -> &BTreeMap<String, MetadataValue>

Source

pub fn insert<K, V>(&mut self, key: K, value: V)
where K: Into<String>, V: Into<MetadataValue>,

Source

pub fn get(&self, key: &str) -> Option<&MetadataValue>

Source

pub fn get_str(&self, key: &str) -> Option<&str>

Source

pub fn iter(&self) -> impl Iterator<Item = (&String, &MetadataValue)>

Source

pub fn merge_missing(&mut self, other: &ErrorMetadata)

Merge entries from other, keeping existing values.

For each key in other, the value is only inserted if the key does not already exist in self. This implements an inner/first wins strategy useful when merging layered metadata where earlier layers should take priority.

See StructError::context_metadata() for a usage example.

Trait Implementations§

Source§

impl Clone for ErrorMetadata

Source§

fn clone(&self) -> ErrorMetadata

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ErrorMetadata

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ErrorMetadata

Source§

fn default() -> ErrorMetadata

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ErrorMetadata

Source§

fn eq(&self, other: &ErrorMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for ErrorMetadata

Source§

impl StructuralPartialEq for ErrorMetadata

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.