Enum relay_event_schema::protocol::InstructionAddrAdjustment

pub enum InstructionAddrAdjustment {
    Auto,
    AllButFirst,
    All,
    None,
    Unknown(String),
}

Controls the mechanism by which the instruction_addr of a Stacktrace Frame is adjusted.

The adjustment tries to transform return addresses to call addresses for symbolication. Typically, this adjustment needs to be done for all frames but the first, as the first frame is usually taken directly from the cpu context of a hardware exception or a suspended thread and the stack trace is created from that.

When the stack walking implementation truncates frames from the top, "all" frames should be adjusted. In case the stack walking implementation already does the adjustment when producing stack frames, "none" should be used here.

Variants

Auto

The default. Applies a heuristic based on other event / exception attributes.

AllButFirst

All but the first frame needs to be adjusted. The first frame’s address is not a return address, but points directly to the faulty instruction.

All

All frames should be adjusted, for example because the stack walking implementation truncated frames from the top of the stack, and all remaining frames’ addresses are return addresses.

None

The stack walking implementation already provides correct addresses and no adjustment should be performed when symbolicating.

Unknown(String)

Any other unknown adjustment strategy.

This exists to ensure forward compatibility.

Implementations

impl InstructionAddrAdjustment

pub fn as_str(&self) -> &str

Returns the string representation of this adjustment.

Trait Implementations

impl Clone for InstructionAddrAdjustment

fn clone(&self) -> InstructionAddrAdjustment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstructionAddrAdjustment

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

Formats the value using the given formatter.

impl Default for InstructionAddrAdjustment

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InstructionAddrAdjustment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InstructionAddrAdjustment

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

Formats the value using the given formatter.

impl Empty for InstructionAddrAdjustment

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 FromStr for InstructionAddrAdjustment

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl FromValue for InstructionAddrAdjustment

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

Creates a meta structure from an annotated boxed value.

impl IntoValue for InstructionAddrAdjustment

fn into_value(self) -> Value

where Self: Sized,

Boxes the meta structure back into a value.

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

where Self: Sized, S: Serializer,

Efficiently serializes the payload directly.

fn extract_child_meta(&self) -> BTreeMap<String, MetaTree>

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 InstructionAddrAdjustment

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

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 Serialize for InstructionAddrAdjustment

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for InstructionAddrAdjustment

impl StructuralPartialEq for InstructionAddrAdjustment