Struct relay_event_schema::protocol::Exception

pub struct Exception {
    pub ty: Annotated<String>,
    pub value: Annotated<JsonLenientString>,
    pub module: Annotated<String>,
    pub stacktrace: Annotated<Stacktrace>,
    pub raw_stacktrace: Annotated<RawStacktrace>,
    pub thread_id: Annotated<ThreadId>,
    pub mechanism: Annotated<Mechanism>,
    pub other: Object<Value>,
}

A single exception.

Multiple values inside of an event represent chained exceptions and should be sorted oldest to newest. For example, consider this Python code snippet:

try:
    raise Exception("random boring invariant was not met!")
except Exception as e:
    raise ValueError("something went wrong, help!") from e

Exception would be described first in the values list, followed by a description of ValueError:

{
  "exception": {
    "values": [
      {"type": "Exception": "value": "random boring invariant was not met!"},
      {"type": "ValueError", "value": "something went wrong, help!"},
    ]
  }
}

Fields

ty: Annotated<String>

Exception type, e.g. ValueError.

At least one of type or value is required, otherwise the exception is discarded.

value: Annotated<JsonLenientString>

Human readable display value.

At least one of type or value is required, otherwise the exception is discarded.

module: Annotated<String>

The optional module, or package which the exception type lives in.

stacktrace: Annotated<Stacktrace>

Stack trace containing frames of this exception.

raw_stacktrace: Annotated<RawStacktrace>

Optional unprocessed stack trace.

thread_id: Annotated<ThreadId>

An optional value that refers to a thread.

mechanism: Annotated<Mechanism>

Mechanism by which this exception was generated and handled.

other: Object<Value>

Additional arbitrary fields for forwards compatibility.

Trait Implementations

impl Clone for Exception

fn clone(&self) -> Exception

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Exception

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

Formats the value using the given formatter.

impl Default for Exception

fn default() -> Exception

Returns the “default value” for a type.

impl Empty for Exception

fn is_empty(&self) -> bool

Returns whether this value is empty.

fn is_deep_empty(&self) -> bool

Returns whether this value is empty or all of its descendants are empty.

impl FromValue for Exception

fn from_value(__value: Annotated<Value>) -> Annotated<Self>

Creates a meta structure from an annotated boxed value.

impl Getter for Exception

fn get_value(&self, path: &str) -> Option<Val<'_>>

Returns the serialized value of a field pointed to by a path.

fn get_iter(&self, _path: &str) -> Option<GetterIter<'_>>

Returns an iterator over the array pointed to by a path.

impl IntoValue for Exception

fn into_value(self) -> Value

Boxes the meta structure back into a value.

fn serialize_payload<S>( &self, __serializer: S, __behavior: SkipSerialization, ) -> Result<S::Ok, S::Error>

where Self: Sized, S: Serializer,

Efficiently serializes the payload directly.

fn extract_child_meta(&self) -> MetaMap

where Self: Sized,

Extracts children meta map out of a value.

fn extract_meta_tree(value: &Annotated<Self>) -> MetaTree

where Self: Sized,

Extracts the meta tree out of annotated value.

impl PartialEq for Exception

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

fn value_type(&self) -> EnumSet<ValueType>

Returns the type of the value.

fn process_value<P>( &mut self, __meta: &mut Meta, __processor: &mut P, __state: &ProcessingState<'_>, ) -> ProcessingResult

where P: Processor,

Executes a processor on this value.

fn process_child_values<P>( &mut self, __processor: &mut P, __state: &ProcessingState<'_>, ) -> ProcessingResult

where P: Processor,

Recurses into children of this value.

impl StructuralPartialEq for Exception