Skip to main content

EffectTrace

Struct EffectTrace 

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

An effect trace that collects effects during parsing.

Effect traces are composable and can be filtered or transformed.

Implementations§

Source§

impl EffectTrace

Source

pub fn new() -> Self

Create a new empty effect trace.

Source

pub fn record(&mut self, effect: ParserEffect)

Record an effect in the trace.

If the effect is terminal (FailClosed), subsequent effects are still recorded but the trace is marked as terminated.

Source

pub fn is_terminated(&self) -> bool

Returns true if the trace contains any terminal effects.

Source

pub fn is_empty(&self) -> bool

Returns true if the trace has no effects.

Source

pub fn len(&self) -> usize

Returns the number of effects in the trace.

Source

pub fn effects(&self) -> &[ParserEffect]

Returns a slice of all effects.

Source

pub fn terminal(&self) -> Option<&ParserEffect>

Returns the terminal effect, if any.

Source

pub fn filter_kind(&self, kind: ParserEffectKind) -> Vec<&ParserEffect>

Filter effects by kind.

Source

pub fn count_kind(&self, kind: ParserEffectKind) -> usize

Count effects by kind.

Source

pub fn warnings(&self) -> Vec<&ParserEffect>

Returns all warning effects.

Source

pub fn merge(&mut self, other: EffectTrace)

Merge another trace into this one.

Source

pub fn summary(&self) -> EffectTraceSummary

Convert to a summary for logging.

Trait Implementations§

Source§

impl Clone for EffectTrace

Source§

fn clone(&self) -> EffectTrace

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EffectTrace

Source§

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

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

impl Default for EffectTrace

Source§

fn default() -> EffectTrace

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

impl<'de> Deserialize<'de> for EffectTrace

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for EffectTrace

Source§

fn eq(&self, other: &EffectTrace) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Serialize for EffectTrace

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EffectTrace

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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, 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.