Struct pnet_packet::tcp::MutableTcpPacket [−][src]
pub struct MutableTcpPacket<'p> { /* fields omitted */ }
Expand description
A structure enabling manipulation of on the wire packets
Implementations
impl<'a> MutableTcpPacket<'a>
[src]
impl<'a> MutableTcpPacket<'a>
[src]pub fn new<'p>(packet: &'p mut [u8]) -> Option<MutableTcpPacket<'p>>
[src]
pub fn new<'p>(packet: &'p mut [u8]) -> Option<MutableTcpPacket<'p>>
[src]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>>
[src]
pub fn owned(packet: Vec<u8>) -> Option<MutableTcpPacket<'static>>
[src]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>
[src]
pub fn to_immutable<'p>(&'p self) -> TcpPacket<'p>
[src]Maps from a MutableTcpPacket to a TcpPacket
pub fn consume_to_immutable(self) -> TcpPacket<'a>
[src]
pub fn consume_to_immutable(self) -> TcpPacket<'a>
[src]Maps from a MutableTcpPacket to a TcpPacket while consuming the source
pub const fn minimum_packet_size() -> usize
[src]
pub const 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]
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]
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]
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]
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]
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]
pub fn get_data_offset(&self) -> u4
[src]Get the data_offset field.
pub fn get_reserved(&self) -> u3
[src]
pub fn get_reserved(&self) -> u3
[src]Get the reserved field.
pub fn get_flags(&self) -> u9be
[src]
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]
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]
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]
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]
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]
pub fn get_options(&self) -> Vec<TcpOption>
[src]Get the value of the options field (copies contents)
pub fn get_options_iter(&self) -> TcpOptionIterable<'_>ⓘNotable traits for TcpOptionIterable<'a>
impl<'a> Iterator for TcpOptionIterable<'a> type Item = TcpOptionPacket<'a>;
[src]
pub fn get_options_iter(&self) -> TcpOptionIterable<'_>ⓘNotable traits for TcpOptionIterable<'a>
impl<'a> Iterator for TcpOptionIterable<'a> type Item = TcpOptionPacket<'a>;
[src]Get the value of the options field as iterator
pub fn set_source(&mut self, val: u16be)
[src]
pub fn set_source(&mut self, val: u16be)
[src]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: u16be)
[src]
pub fn set_destination(&mut self, val: u16be)
[src]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: u32be)
[src]
pub fn set_sequence(&mut self, val: u32be)
[src]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: u32be)
[src]
pub fn set_acknowledgement(&mut self, val: u32be)
[src]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: u4)
[src]
pub fn set_data_offset(&mut self, val: u4)
[src]Set the data_offset field.
pub fn set_reserved(&mut self, val: u3)
[src]
pub fn set_reserved(&mut self, val: u3)
[src]Set the reserved field.
pub fn set_flags(&mut self, val: u9be)
[src]
pub fn set_flags(&mut self, val: u9be)
[src]Set the flags field. This field is always stored big-endian within the struct, but this mutator wants host order.
pub fn set_window(&mut self, val: u16be)
[src]
pub fn set_window(&mut self, val: u16be)
[src]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: u16be)
[src]
pub fn set_checksum(&mut self, val: u16be)
[src]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: u16be)
[src]
pub fn set_urgent_ptr(&mut self, val: u16be)
[src]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]
[src]
pub fn get_options_raw_mut(&mut self) -> &mut [u8]
[src]Get the raw &mut u8 value of the options field, without copying
pub fn set_options(&mut self, vals: &[TcpOption])
[src]
pub fn set_options(&mut self, vals: &[TcpOption])
[src]Set the value of the options field (copies contents)
pub fn set_payload(&mut self, vals: &[u8])
[src]
pub fn set_payload(&mut self, vals: &[u8])
[src]Set the value of the payload field (copies contents)
Trait Implementations
impl<'p> Debug for MutableTcpPacket<'p>
[src]
impl<'p> Debug for MutableTcpPacket<'p>
[src]impl<'p> FromPacket for MutableTcpPacket<'p>
[src]
impl<'p> FromPacket for MutableTcpPacket<'p>
[src]fn from_packet(&self) -> Tcp
[src]
fn from_packet(&self) -> Tcp
[src]Converts a wire-format packet to #[packet] struct format.
impl<'a> MutablePacket for MutableTcpPacket<'a>
[src]
impl<'a> MutablePacket for MutableTcpPacket<'a>
[src]fn packet_mut<'p>(&'p mut self) -> &'p mut [u8]
[src]
fn packet_mut<'p>(&'p mut self) -> &'p mut [u8]
[src]Retreive the underlying, mutable, buffer for the packet.
fn payload_mut<'p>(&'p mut self) -> &'p mut [u8]
[src]
fn payload_mut<'p>(&'p mut self) -> &'p mut [u8]
[src]Retreive the mutable payload for the packet.
fn clone_from<T>(&mut self, other: &T) where
T: Packet,
[src]
fn clone_from<T>(&mut self, other: &T) where
T: Packet,
[src]Initialize this packet by cloning another.
impl<'a> Packet for MutableTcpPacket<'a>
[src]
impl<'a> Packet for MutableTcpPacket<'a>
[src]impl<'a> PacketSize for MutableTcpPacket<'a>
[src]
impl<'a> PacketSize for MutableTcpPacket<'a>
[src]fn packet_size(&self) -> usize
[src]
fn packet_size(&self) -> usize
[src]Get the calculated size of the packet.
impl<'p> PartialEq<MutableTcpPacket<'p>> for MutableTcpPacket<'p>
[src]
impl<'p> PartialEq<MutableTcpPacket<'p>> for MutableTcpPacket<'p>
[src]fn eq(&self, other: &MutableTcpPacket<'p>) -> bool
[src]
fn eq(&self, other: &MutableTcpPacket<'p>) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &MutableTcpPacket<'p>) -> bool
[src]
fn ne(&self, other: &MutableTcpPacket<'p>) -> bool
[src]This method tests for !=
.