Skip to main content

DecodeReport

Struct DecodeReport 

Source
pub struct DecodeReport {
    pub messages: usize,
    pub controls: usize,
    pub control_cancels: usize,
    pub control_responses: usize,
    pub unknown_types: Vec<String>,
    pub unknown_control_subtypes: Vec<String>,
    pub unmodelled_system_subtypes: Vec<String>,
    pub unmodelled_content_block_types: Vec<String>,
    pub absorbed_by_catch_all: Vec<String>,
    pub decode_errors: Vec<(usize, String)>,
}
Expand description

Outcome of running every inbound line in a log through decode_dispatch. Split across known decode categories plus Unknowns and outright errors.

Fields§

§messages: usize

Count of inbound lines that decoded to a regular Message.

§controls: usize

Count of inbound lines that decoded to a ControlRequest.

§control_cancels: usize

Count of control_cancel_request frames.

§control_responses: usize

Count of control_response frames (replies from the CLI to our outbound control_requests - initialize, set_model, interrupt, …).

§unknown_types: Vec<String>

Unrecognised type values seen. Each entry is the type string the CLI sent.

§unknown_control_subtypes: Vec<String>

Unrecognised control_request.subtype values seen.

§unmodelled_system_subtypes: Vec<String>

system subtypes that fell through to the generic Message::System bucket and are not in EXPECTED_GENERIC_SYSTEM_SUBTYPES.

§unmodelled_content_block_types: Vec<String>

Content-block type values that decoded to ContentBlock::Unknown.

§absorbed_by_catch_all: Vec<String>

Wire values a #[serde(other)] catch-all absorbed. Each entry is <json pointer>: <wire value> -> <fallback>.

§decode_errors: Vec<(usize, String)>

Hard decode errors - line was recognised but inner shape was invalid, or JSON malformed.

Implementations§

Source§

impl DecodeReport

Source

pub fn is_clean(&self) -> bool

True if no Unknowns or decode errors were seen.

Trait Implementations§

Source§

impl Debug for DecodeReport

Source§

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

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

impl Default for DecodeReport

Source§

fn default() -> Self

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

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more