Struct zero_packet::packet::builder::PacketBuilder

pub struct PacketBuilder<'a, State> { /* private fields */ }

A zero-copy packet builder.

Using the typestate pattern, a state machine is implemented using the type system. The state machine ensures that the package is built correctly.

The creation of new PacketBuilder instances happens on the stack. These stack allocations are very cheap and most likely optimized away by the compiler. The state types are zero-sized types (ZSTs) and don’t consume any memory.

Implementations

impl<'a, State> PacketBuilder<'a, State>

pub fn header_len(&self) -> usize

Returns the length of all encapsulated headers in bytes.

pub fn payload_len(&self) -> usize

Returns the length of the payload in bytes.

The payload is the data after all headers.

Should be called after all headers have been set.

pub fn payload(&self) -> &[u8]

Returns the payload.

The payload is the data after all headers.

Should be called after all headers have been set.

pub fn build(self) -> &'a [u8]

Returns a reference to the data slice.

impl<'a> PacketBuilder<'a, RawState>

pub fn new(data: &'a mut [u8]) -> PacketBuilder<'a, RawState>

Creates a new PacketBuilder from the given data slice.

pub fn ethernet( self, src_mac: &[u8; 6], dest_mac: &[u8; 6], ethertype: u16, ) -> Result<PacketBuilder<'a, EthernetHeaderState>, &'static str>

Sets Ethernet II header fields.

Transition: Raw -> EthernetHeader.

impl<'a> PacketBuilder<'a, EthernetHeaderState>

pub fn arp( self, hardware_type: u16, protocol_type: u16, hardware_address_length: u8, protocol_address_length: u8, operation: u16, src_mac: &[u8; 6], src_ip: &[u8; 4], dest_mac: &[u8; 6], dest_ip: &[u8; 4], ) -> Result<PacketBuilder<'a, ArpHeaderState>, &'static str>

Sets ARP header fields.

Transition: EthernetHeader -> ArpHeader.

pub fn ipv4( self, version: u8, ihl: u8, dscp: u8, ecn: u8, total_length: u16, identification: u16, flags: u8, fragment_offset: u16, ttl: u8, protocol: u8, src_ip: &[u8; 4], dest_ip: &[u8; 4], ) -> Result<PacketBuilder<'a, Ipv4HeaderState>, &'static str>

Sets IPv4 header fields.

Transition: EthernetHeader -> Ipv4Header.

impl<'a> PacketBuilder<'a, Ipv4HeaderState>

pub fn tcp( self, src_ip: &[u8; 4], src_port: u16, dest_ip: &[u8; 4], dest_port: u16, sequence_number: u32, acknowledgment_number: u32, reserved: u8, data_offset: u8, flags: u8, window_size: u16, urgent_pointer: u16, ) -> Result<PacketBuilder<'a, TcpHeaderState>, &'static str>

Sets TCP header fields.

Transition: Ipv4Header -> TcpHeader.

pub fn udp( self, src_ip: &[u8; 4], src_port: u16, dest_ip: &[u8; 4], dest_port: u16, length: u16, ) -> Result<PacketBuilder<'a, UdpHeaderState>, &'static str>

Sets UDP header fields.

Transition: Ipv4Header -> UdpHeader.

pub fn icmp( self, icmp_type: u8, icmp_code: u8, ) -> Result<PacketBuilder<'a, IcmpHeaderState>, &'static str>

Sets ICMP header fields.

Transition: Ipv4Header -> IcmpHeader.

Trait Implementations

impl<'a> PayloadWriter<'a> for PacketBuilder<'a, IcmpHeaderState>

fn write_payload( self, payload: &[u8], ) -> Result<PacketBuilder<'a, PayloadState>, &'static str>

Writes a given payload to the packet and transitions into the Payload state.

impl<'a> PayloadWriter<'a> for PacketBuilder<'a, TcpHeaderState>

fn write_payload( self, payload: &[u8], ) -> Result<PacketBuilder<'a, PayloadState>, &'static str>

Writes a given payload to the packet and transitions into the Payload state.

impl<'a> PayloadWriter<'a> for PacketBuilder<'a, UdpHeaderState>

fn write_payload( self, payload: &[u8], ) -> Result<PacketBuilder<'a, PayloadState>, &'static str>

Writes a given payload to the packet and transitions into the Payload state.