Struct relay_event_schema::processor::ProcessingState

pub struct ProcessingState<'a> { /* private fields */ }

An event’s processing state.

The processing state describes an item in an event which is being processed, an example of processing might be scrubbing the event for PII. The processing state itself describes the current item and it’s parent, which allows you to follow all the items up to the root item. You can think of processing an event as a visitor pattern visiting all items in the event and the processing state is a stack describing the currently visited item and all it’s parents.

Implementations

impl<'a> ProcessingState<'a>

pub fn root() -> &'static ProcessingState<'static>

Returns the root processing state.

pub fn new_root( attrs: Option<Cow<'static, FieldAttrs>>, value_type: impl IntoIterator<Item = ValueType>, ) -> ProcessingState<'static>

Creates a new root state.

pub fn enter_static( &'a self, key: &'static str, attrs: Option<Cow<'static, FieldAttrs>>, value_type: impl IntoIterator<Item = ValueType>, ) -> Self

Derives a processing state by entering a static key.

pub fn enter_borrowed( &'a self, key: &'a str, attrs: Option<Cow<'a, FieldAttrs>>, value_type: impl IntoIterator<Item = ValueType>, ) -> Self

Derives a processing state by entering a borrowed key.

pub fn enter_owned( self, key: String, attrs: Option<Cow<'a, FieldAttrs>>, value_type: impl IntoIterator<Item = ValueType>, ) -> Self

Derives a processing state by entering an owned key.

The new (child) state takes ownership of the current (parent) state.

pub fn enter_index( &'a self, idx: usize, attrs: Option<Cow<'a, FieldAttrs>>, value_type: impl IntoIterator<Item = ValueType>, ) -> Self

Derives a processing state by entering an index.

pub fn enter_nothing(&'a self, attrs: Option<Cow<'a, FieldAttrs>>) -> Self

Derives a processing state without adding a path segment. Useful in newtype structs.

pub fn path(&'a self) -> Path<'a>

Returns the path in the processing state.

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

pub fn attrs(&self) -> &FieldAttrs

Returns the field attributes.

pub fn inner_attrs(&self) -> Option<Cow<'_, FieldAttrs>>

Derives the attrs for recursion.

pub fn iter(&'a self) -> ProcessingStateIter<'a>

Iterates through this state and all its ancestors up the hierarchy.

This starts at the top of the stack of processing states and ends at the root. Thus the first item returned is the currently visited leaf of the event structure.

pub fn try_into_parent(self) -> Result<Option<Self>, Self>

Returns the contained parent state.

• Returns Ok(None) if the current state is the root.
• Returns Err(self) if the current state does not own the parent state.

pub fn depth(&'a self) -> usize

Return the depth (~ indentation level) of the currently processed value.

pub fn entered_anything(&'a self) -> bool

Return whether the depth changed between parent and self.

This is false when we entered a newtype struct.

Trait Implementations

impl<'a> Clone for ProcessingState<'a>

fn clone(&self) -> ProcessingState<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ProcessingState<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ProcessingState<'a>

fn default() -> Self

Returns the “default value” for a type.