Struct TcpOptionPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> TcpOptionPacket<'a>

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

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

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

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

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

Maps from a TcpOptionPacket to a TcpOptionPacket

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

Maps from a TcpOptionPacket to a TcpOptionPacket 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: &TcpOption) -> usize

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

pub fn get_number(&self) -> TcpOptionNumber

Get the value of the number field

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

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

pub fn get_length(&self) -> Vec<u8>

Get the value of the length field (copies contents)

Trait Implementations

impl<'p> Debug for TcpOptionPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for TcpOptionPacket<'p>

type T = TcpOption

The type of the packet to convert from.

fn from_packet(&self) -> TcpOption

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

impl<'a> Packet for TcpOptionPacket<'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 TcpOptionPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for TcpOptionPacket<'p>

fn eq(&self, other: &TcpOptionPacket<'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 TcpOptionPacket<'p>