Struct pnet::packet::tcp::MutableTcpPacket [] [src]

pub struct MutableTcpPacket<'p> {
    // some fields omitted
}

A structure enabling manipulation of on the wire packets

Methods

impl<'a> MutableTcpPacket<'a>
[src]

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.

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

Maps from a MutableTcpPacket to a TcpPacket

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.

fn packet_size(_packet: &Tcp) -> usize

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

fn populate(&mut self, packet: &Tcp)

Populates a TcpPacket using a Tcp structure

fn get_source(&self) -> u16be

Get the source field

fn get_destination(&self) -> u16be

Get the destination field

fn get_sequence(&self) -> u32be

Get the sequence field

fn get_acknowledgement(&self) -> u32be

Get the acknowledgement field

fn get_data_offset(&self) -> u4

Get the data_offset field

fn get_reserved(&self) -> u3

Get the reserved field

fn get_flags(&self) -> u9be

Get the flags field

fn get_window(&self) -> u16be

Get the window field

fn get_checksum(&self) -> u16be

Get the checksum field

fn get_urgent_ptr(&self) -> u16be

Get the urgent_ptr field

fn get_options_raw(&self) -> &[u8]

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

fn get_options(&self) -> Vec<TcpOption>

Get the value of the options field (copies contents)

fn get_options_iter(&self) -> TcpOptionIterable

Get the value of the options field as iterator

fn set_source(&mut self, val: u16be)

Set the source field

fn set_destination(&mut self, val: u16be)

Set the destination field

fn set_sequence(&mut self, val: u32be)

Set the sequence field

fn set_acknowledgement(&mut self, val: u32be)

Set the acknowledgement field

fn set_data_offset(&mut self, val: u4)

Set the data_offset field

fn set_reserved(&mut self, val: u3)

Set the reserved field

fn set_flags(&mut self, val: u9be)

Set the flags field

fn set_window(&mut self, val: u16be)

Set the window field

fn set_checksum(&mut self, val: u16be)

Set the checksum field

fn set_urgent_ptr(&mut self, val: u16be)

Set the urgent_ptr field

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

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

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

Set the value of the options field (copies contents)

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

Set the value of the payload field (copies contents)

Trait Implementations

impl<'a> PacketSize for MutableTcpPacket<'a>
[src]

fn packet_size(&self) -> usize

Get the calculated size of the packet

impl<'a> MutablePacket for MutableTcpPacket<'a>
[src]

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

Retreive the underlying, mutable, buffer for the packet

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

Retreive the mutable payload for the packet

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

Initialize this packet by cloning another

impl<'a> Packet for MutableTcpPacket<'a>
[src]

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

Retreive the underlying buffer for the packet

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

Retreive the payload for the packet

impl<'p> FromPacket for MutableTcpPacket<'p>
[src]

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<'p> Debug for MutableTcpPacket<'p>
[src]

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

Formats the value using the given formatter.

Derived Implementations

impl<'p> PartialEq for MutableTcpPacket<'p>
[src]

fn eq(&self, __arg_0: &MutableTcpPacket<'p>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, __arg_0: &MutableTcpPacket<'p>) -> bool

This method tests for !=.