ParseResult

Struct ParseResult 

Source
pub struct ParseResult<'data> {
    pub fields: SmallVec<[FieldEntry<'data>; 16]>,
    pub remaining: &'data [u8],
    pub child_hints: SmallVec<[HintEntry; 4]>,
    pub error: Option<String>,
    pub encap_depth: u8,
    pub tunnel_type: TunnelType,
    pub tunnel_id: Option<u64>,
}
Expand description

Result of parsing a protocol layer.

Uses SmallVec for inline storage to avoid HashMap allocation overhead. Most protocols have <16 fields and <4 child hints, so these fit inline.

The lifetime parameter 'data ties the result to the packet/buffer data, allowing zero-copy parsing where field values reference the packet directly.

Fields§

§fields: SmallVec<[FieldEntry<'data>; 16]>

Extracted field values. Most protocols have <16 fields. Field values may reference the packet data (zero-copy).

§remaining: &'data [u8]

Remaining unparsed bytes (payload for next layer).

§child_hints: SmallVec<[HintEntry; 4]>

Hints for child protocol identification. Typically 2-4 entries.

§error: Option<String>

Parse error if partial parsing occurred.

§encap_depth: u8

Encapsulation depth when this protocol was parsed (0 = outer layer).

§tunnel_type: TunnelType

Type of the innermost enclosing tunnel (if inside a tunnel).

§tunnel_id: Option<u64>

Identifier of the innermost enclosing tunnel (VNI, GRE key, TEID, etc.).

Implementations§

Source§

impl<'data> ParseResult<'data>

Source

pub fn success( fields: SmallVec<[FieldEntry<'data>; 16]>, remaining: &'data [u8], child_hints: SmallVec<[HintEntry; 4]>, ) -> Self

Create a successful parse result.

Note: encap_depth, tunnel_type, and tunnel_id default to 0/None. These are populated by the parse loop from the ParseContext after parsing.

Source

pub fn error(error: String, remaining: &'data [u8]) -> Self

Create an error parse result.

Source

pub fn partial( fields: SmallVec<[FieldEntry<'data>; 16]>, remaining: &'data [u8], error: String, ) -> Self

Create a result with partial fields and an error.

Source

pub fn set_encap_context(&mut self, ctx: &ParseContext)

Set encapsulation context from a ParseContext.

Source

pub fn get(&self, name: &str) -> Option<&FieldValue<'data>>

Get a field value by name (linear search, but N is small).

Source

pub fn hint(&self, name: &str) -> Option<u64>

Get a child hint value by name.

Source

pub fn is_ok(&self) -> bool

Check if parsing was successful.

Trait Implementations§

Source§

impl<'data> Clone for ParseResult<'data>

Source§

fn clone(&self) -> ParseResult<'data>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'data> Debug for ParseResult<'data>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'data> Freeze for ParseResult<'data>

§

impl<'data> RefUnwindSafe for ParseResult<'data>

§

impl<'data> Send for ParseResult<'data>

§

impl<'data> Sync for ParseResult<'data>

§

impl<'data> Unpin for ParseResult<'data>

§

impl<'data> UnwindSafe for ParseResult<'data>

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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