Metadata

Struct Metadata 

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

Structured metadata attached to crate::AppError.

Internally backed by a deterministic BTreeMap keyed by 'static field names. Use the helpers in field to build Field values without manual enum construction.

Implementations§

Source§

impl Metadata

Source

pub fn new() -> Self

Create an empty metadata container.

Source

pub fn from_fields(fields: impl IntoIterator<Item = Field>) -> Self

Build metadata from an iterator of Field values.

Source

pub fn len(&self) -> usize

Number of fields stored in the metadata.

Source

pub fn is_empty(&self) -> bool

Whether the metadata is empty.

Source

pub fn insert(&mut self, field: Field) -> Option<FieldValue>

Insert or replace a field and return the previous value.

Source

pub fn extend(&mut self, fields: impl IntoIterator<Item = Field>)

Extend metadata with additional fields.

Source

pub fn get(&self, name: &'static str) -> Option<&FieldValue>

Borrow a field value by name.

Source

pub fn get_field(&self, name: &'static str) -> Option<&Field>

Borrow the full field entry by name.

Source

pub fn set_redaction(&mut self, name: &'static str, redaction: FieldRedaction)

Override the redaction policy for a specific field.

Source

pub fn redaction(&self, name: &'static str) -> Option<FieldRedaction>

Retrieve the redaction policy for a field if present.

Source

pub fn iter(&self) -> impl Iterator<Item = (&'static str, &FieldValue)>

Iterator over metadata fields in sorted order.

Source

pub fn iter_with_redaction( &self, ) -> impl Iterator<Item = (&'static str, &FieldValue, FieldRedaction)>

Iterator over metadata entries including the redaction policy.

Trait Implementations§

Source§

impl Clone for Metadata

Source§

fn clone(&self) -> Metadata

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 Metadata

Source§

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

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

impl Default for Metadata

Source§

fn default() -> Metadata

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

impl IntoIterator for Metadata

Source§

type Item = Field

The type of the elements being iterated over.
Source§

type IntoIter = Map<IntoIter<&'static str, Field>, fn((&'static str, Field)) -> Field>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for Metadata

Source§

fn eq(&self, other: &Metadata) -> 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 StructuralPartialEq for Metadata

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> Same for T

Source§

type Output = T

Should always be Self
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.