Struct pnet_packet::tcp::TcpPacket
[−]
[src]
pub struct TcpPacket<'p> { /* fields omitted */ }
A structure enabling manipulation of on the wire packets
Methods
impl<'a> TcpPacket<'a>
[src]
pub fn new<'p>(packet: &'p [u8]) -> Option<TcpPacket<'p>>
[src]
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>>
[src]
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>
[src]
Maps from a TcpPacket to a TcpPacket
pub fn consume_to_immutable(self) -> TcpPacket<'a>
[src]
Maps from a TcpPacket to a TcpPacket while consuming the source
pub fn minimum_packet_size() -> usize
[src]
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
[src]
The size (in bytes) of a Tcp instance when converted into a byte-array
pub fn get_source(&self) -> u16be
[src]
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) -> u16be
[src]
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) -> u32be
[src]
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) -> u32be
[src]
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) -> u4
[src]
Get the data_offset field.
pub fn get_reserved(&self) -> u3
[src]
Get the reserved field.
pub fn get_flags(&self) -> u9be
[src]
Get the flags field. This field is always stored big-endian within the struct, but this accessor returns host order.
pub fn get_window(&self) -> u16be
[src]
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) -> u16be
[src]
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) -> u16be
[src]
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]
[src]
Get the raw &[u8] value of the options field, without copying
pub fn get_options(&self) -> Vec<TcpOption>
[src]
Get the value of the options field (copies contents)
ⓘImportant traits for TcpOptionIterable<'a>pub fn get_options_iter(&self) -> TcpOptionIterable
[src]
Get the value of the options field as iterator
Trait Implementations
impl<'p> PartialEq for TcpPacket<'p>
[src]
fn eq(&self, __arg_0: &TcpPacket<'p>) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &TcpPacket<'p>) -> bool
[src]
This method tests for !=
.
impl<'a> PacketSize for TcpPacket<'a>
[src]
fn packet_size(&self) -> usize
[src]
Get the calculated size of the packet
impl<'a> Packet for TcpPacket<'a>
[src]
fn packet<'p>(&'p self) -> &'p [u8]
[src]
Retreive the underlying buffer for the packet
fn payload<'p>(&'p self) -> &'p [u8]
[src]
Retreive the payload for the packet
impl<'p> FromPacket for TcpPacket<'p>
[src]
type T = Tcp
The type of the packet to convert from
fn from_packet(&self) -> Tcp
[src]
Converts a wire-format packet to #[packet] struct format