Skip to main content

ErrorContext

Struct ErrorContext 

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

Structured context attached to a single error occurrence.

Records where an error happened (component, operation) and a human-readable message. Optional key/value pairs may carry additional diagnostic information.

§Examples

use oximedia_core::error_context::ErrorContext;

let ctx = ErrorContext::new("muxer", "write_header", "disk full");
assert_eq!(ctx.component(), "muxer");
assert_eq!(ctx.operation(), "write_header");
assert_eq!(ctx.message(), "disk full");

Implementations§

Source§

impl ErrorContext

Source

pub fn new(component: &str, operation: &str, message: &str) -> Self

Creates a new context with the given component, operation, and message.

Source

pub fn component(&self) -> &str

Returns the name of the component that raised the error.

Source

pub fn operation(&self) -> &str

Returns the name of the operation that was in progress.

Source

pub fn message(&self) -> &str

Returns the human-readable error message.

Source

pub fn with_field(&mut self, key: &str, value: &str) -> &mut Self

Attaches an additional key/value diagnostic field.

Calling this multiple times with the same key overwrites the previous value.

Source

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

Returns the value of a diagnostic field, or None if absent.

Source

pub fn fields(&self) -> impl Iterator<Item = (&str, &str)>

Returns an iterator over all attached diagnostic fields.

Trait Implementations§

Source§

impl Clone for ErrorContext

Source§

fn clone(&self) -> ErrorContext

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 ErrorContext

Source§

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

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

impl Display for ErrorContext

Source§

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

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

impl PartialEq for ErrorContext

Source§

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

Source§

impl StructuralPartialEq for ErrorContext

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.