Struct ModbusParser 

pub struct ModbusParser { /* private fields */ }

Available on crate feature modbus only.

SessionParser for Modbus/TCP. Drains zero or more ModbusMessages per feed call. Defensively caps the internal buffer at 64 KiB per direction — a single pathological frame larger than 65 KiB would be the only thing that could occupy more.

Implementations

impl ModbusParser

pub fn new() -> Self

Trait Implementations

impl Clone for ModbusParser

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModbusParser

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

Formats the value using the given formatter.

impl Default for ModbusParser

fn default() -> Self

Returns the “default value” for a type.

impl SessionParser for ModbusParser

fn on_gap( &mut self, side: FlowSide, _missing: u64, _ts: Timestamp, _out: &mut Vec<ModbusMessage>, ) -> GapResponse

Available on crate feature session only.

Drop the partial frame and resume at the next plausible MBAP header.

type Message = ModbusMessage

Available on crate feature session only.

L7 message produced by this parser.

fn parser_kind(&self) -> ParserKind

Available on crate feature session only.

Typed identity of this parser, surfaced on crate::driver::Event::ParserClosed::parser_kind and crate::driver::SlotHandle::parser_kind. Lifted from &'static str to the ParserKind enum in 0.20 (#109); originally added in 0.5.0.

fn feed_initiator( &mut self, bytes: &[u8], _ts: Timestamp, out: &mut Vec<Self::Message>, )

Available on crate feature session only.

Feed the next chunk of bytes from the initiator side. ts is the observed time of the packet carrying these bytes. Push any complete messages parsed during this call into out.

fn feed_responder( &mut self, bytes: &[u8], _ts: Timestamp, out: &mut Vec<Self::Message>, )

Available on crate feature session only.

Feed the next chunk of bytes from the responder side.

fn fin_initiator(&mut self, _out: &mut Vec<Self::Message>)

Available on crate feature session only.

The initiator side ended cleanly: called once at flow end when the flow ended gracefully (EndReason::is_graceful: FIN, idle timeout, force close) or the initiator sent a FIN — after its final bytes were fed. Not called for a side the parser stopped reading (GapResponse::StopSide, reassembly stop). Default: no-op.

fn fin_responder(&mut self, _out: &mut Vec<Self::Message>)

Available on crate feature session only.

The responder side ended cleanly; see fin_initiator.

fn rst_initiator(&mut self)

Available on crate feature session only.

The initiator side ended abruptly: called once at flow end instead of fin_initiator when the flow was not ended gracefully (RST, eviction) and this side sent no FIN. Not called for a stopped side. Default: no-op.

fn rst_responder(&mut self)

Available on crate feature session only.

The responder side ended abruptly; see rst_initiator.

fn on_tick(&mut self, _now: Timestamp, _out: &mut Vec<Self::Message>)

Available on crate feature session only.

Periodic time hook. The driver calls this on every sweep / finish with the sweep’s now, for every still-live parser. Lets stateful parsers emit time-driven messages (timeouts, unanswered requests). Emitted messages are attributed to FlowSide::Initiator. Default: no-op.

fn is_poisoned(&self) -> bool

Available on crate feature session only.

True after the parser has hit an unrecoverable error and can no longer make progress. The engines check this after every feed_* / on_gap / on_tick call and close the parser on true — it is not fed again for that flow, and the flow itself stays tracked. Default: false (parser never poisons).

fn poison_reason(&self) -> Option<&str>

Available on crate feature session only.

Optional human-readable description of why the parser poisoned. Consulted only when is_poisoned returns true. Default: None.

fn is_done(&self) -> bool

Available on crate feature session only.

Symmetric “I’m done — close this flow cleanly” signal. Default: false (parser never self-terminates).