Skip to main content

Analyzer

Struct Analyzer 

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

A stateful observer of a conversation it is not part of.

Feed it every frame, in order, with the role that sent it. It keeps one Registry from both sides, tracks the active control type, and validates each message with the full cross-message Context — so S2-FRBC-003, S2-STATE-001, S2-INST-001 and S2-PEBC-006 fire here and nowhere else outside a live session.

Decoding is lenient by default: an analyzer that refuses a message carrying a vendor extension hides the peer’s real bug behind its own strictness. Analyzer::strict is the other choice.

Implementations§

Source§

impl Analyzer

Source

pub fn new() -> Self

An observer that has seen nothing yet.

Source

pub const fn profile(self, profile: WireProfile) -> Self

Decode against a particular wire profile.

A transcript of a 0.0.2-beta session must be read as one, or every DDBC.SystemDescription in it is a profile mismatch.

Source

pub const fn strict(self) -> Self

Refuse a message with a property the schema does not define, as an endpoint would.

Source

pub const fn over_s2_connect(self) -> Self

Read the conversation as one carried by S2 Connect, where a handshake is redundant.

Source

pub const fn skew_tolerance(self, tolerance: Duration) -> Self

How far a peer’s clock may differ before it is worth reporting.

Source

pub const fn registry(&self) -> &Registry

Everything the conversation has published, from both sides.

Source

pub const fn active_control_type(&self) -> Option<ControlType>

The control type in force, as the conversation has selected it.

Source

pub const fn phase(&self) -> Phase

Which row of the state table the conversation is on.

Source

pub fn observe( &mut self, sender: EnergyManagementRole, text: &str, now: Timestamp, ) -> Observed

Observe one frame.

Total: a frame that is not JSON, not S2 or not in the profile yields a report carrying S2-MSG-004, not an error — an analyzer that stops at the first bad frame stops exactly where it was needed.

Trait Implementations§

Source§

impl Clone for Analyzer

Source§

fn clone(&self) -> Analyzer

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 Analyzer

Source§

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

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

impl Default for Analyzer

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

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

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

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

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

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