Struct MutableTcpOptionPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableTcpOptionPacket<'a>

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

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

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

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

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

Maps from a MutableTcpOptionPacket to a TcpOptionPacket

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

Maps from a MutableTcpOptionPacket 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 populate(&mut self, packet: &TcpOption)

Populates a TcpOptionPacket using a TcpOption structure

pub fn get_kind(&self) -> TcpOptionKind

Get the value of the kind 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)

pub fn set_kind(&mut self, val: TcpOptionKind)

Set the value of the kind field.

pub fn get_length_raw_mut(&mut self) -> &mut [u8]

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

pub fn set_length(&mut self, vals: &[u8])

Set the value of the length field (copies contents)

pub fn set_data(&mut self, vals: &[u8])

Set the value of the data field (copies contents)

Trait Implementations

impl<'p> Debug for MutableTcpOptionPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableTcpOptionPacket<'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> MutablePacket for MutableTcpOptionPacket<'a>

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

Retrieve the underlying, mutable, buffer for the packet.

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

Retrieve the mutable payload for the packet.

fn clone_from<T>(&mut self, other: &T)

where T: Packet,

Initialize this packet by cloning another.

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

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for MutableTcpOptionPacket<'p>

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