Struct TcpPacket

pub struct TcpPacket<'p> { /* private fields */ }

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> TcpPacket<'a>

pub fn new<'p>(packet: &'p [u8]) -> Option<TcpPacket<'p>>

Constructs a new TcpPacket. If the provided buffer is less than the minimum required packet size, this will return None.

pub fn owned(packet: Vec<u8>) -> Option<TcpPacket<'static>>

Constructs a new TcpPacket. If the provided buffer is less than the minimum required packet size, this will return None. With this constructor the TcpPacket will own its own data and the underlying buffer will be dropped when the TcpPacket is.

pub fn to_immutable<'p>(&'p self) -> TcpPacket<'p>

Maps from a TcpPacket to a TcpPacket

pub fn consume_to_immutable(self) -> TcpPacket<'a>

Maps from a TcpPacket to a TcpPacket while consuming the source

pub const fn minimum_packet_size() -> usize

The minimum size (in bytes) a packet of this type can be. It’s based on the total size of the fixed-size fields.

pub fn packet_size(_packet: &Tcp) -> usize

The size (in bytes) of a Tcp instance when converted into a byte-array

pub fn get_source(&self) -> u16

Get the source field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_destination(&self) -> u16

Get the destination field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_sequence(&self) -> u32

Get the sequence field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_acknowledgement(&self) -> u32

Get the acknowledgement field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_data_offset(&self) -> u8

Get the data_offset field.

pub fn get_reserved(&self) -> u8

Get the reserved field.

pub fn get_flags(&self) -> u8

Get the flags field.

pub fn get_window(&self) -> u16

Get the window field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_checksum(&self) -> u16

Get the checksum field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_urgent_ptr(&self) -> u16

Get the urgent_ptr field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_options_raw(&self) -> &[u8]

Get the raw &u8 value of the options field, without copying

pub fn get_options(&self) -> Vec<TcpOption>

Get the value of the options field (copies contents)

pub fn get_options_iter(&self) -> TcpOptionIterable<'_>

Get the value of the options field as iterator

Trait Implementations

impl<'p> Debug for TcpPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for TcpPacket<'p>

type T = Tcp

The type of the packet to convert from.

fn from_packet(&self) -> Tcp

Converts a wire-format packet to #[packet] struct format.

impl<'a> Packet for TcpPacket<'a>

fn packet<'p>(&'p self) -> &'p [u8]

Retrieve the underlying buffer for the packet.

fn payload<'p>(&'p self) -> &'p [u8]

Retrieve the payload for the packet.

impl<'a> PacketSize for TcpPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for TcpPacket<'p>

fn eq(&self, other: &TcpPacket<'p>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'p> StructuralPartialEq for TcpPacket<'p>