Struct packet::ParseMetadata

pub struct ParseMetadata { /* private fields */ }

Metadata about a previously-parsed packet used to undo its parsing.

See GrowBuffer::undo_parse for more details.

Implementations

impl ParseMetadata

pub fn from_packet( header_len: usize, body_len: usize, footer_len: usize, ) -> ParseMetadata

Constructs a new ParseMetadata from information about a packet.

pub fn from_inner_packet(len: usize) -> ParseMetadata

Constructs a new ParseMetadata from information about an inner packet.

Since inner packets do not have a header/body/footer distinction (at least from the perspective of the utilities in this crate), we arbitrarily produce a ParseMetadata with a header length and no body or footer lengths. Thus, from_inner_packet(len) is equivalent to from_packet(len, 0, 0).

pub fn header_len(&self) -> usize

Gets the header length.

header_len returns the length of the header of the packet described by this ParseMetadata.

pub fn body_len(&self) -> usize

Gets the body length.

body_len returns the length of the body of the packet described by this ParseMetadata.

pub fn footer_len(&self) -> usize

Gets the footer length.

footer_len returns the length of the footer of the packet described by this ParseMetadata.

Trait Implementations

impl Clone for ParseMetadata

fn clone(&self) -> ParseMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParseMetadata

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

Formats the value using the given formatter.

impl PartialEq for ParseMetadata

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ParseMetadata

impl StructuralPartialEq for ParseMetadata