Struct MutableTcpPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableTcpPacket<'a>

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

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

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

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

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

Maps from a MutableTcpPacket to a TcpPacket

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

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

Populates a TcpPacket using a Tcp structure

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

pub fn set_source(&mut self, val: u16)

Set the source field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_destination(&mut self, val: u16)

Set the destination field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_sequence(&mut self, val: u32)

Set the sequence field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_acknowledgement(&mut self, val: u32)

Set the acknowledgement field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_data_offset(&mut self, val: u8)

Set the data_offset field.

pub fn set_reserved(&mut self, val: u8)

Set the reserved field.

pub fn set_flags(&mut self, val: u8)

Set the flags field.

pub fn set_window(&mut self, val: u16)

Set the window field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_checksum(&mut self, val: u16)

Set the checksum field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_urgent_ptr(&mut self, val: u16)

Set the urgent_ptr field. This field is always stored big-endian within the struct, but this mutator wants host order.

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

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

pub fn set_options(&mut self, vals: &[TcpOption])

Set the value of the options field (copies contents)

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

Set the value of the payload field (copies contents)

Trait Implementations

impl<'p> Debug for MutableTcpPacket<'p>

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

Formats the value using the given formatter.

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

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for MutableTcpPacket<'p>

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