Struct etherparse::PacketBuilderStep

pub struct PacketBuilderStep<LastStep> { /* fields omitted */ }

An unfinished packet that is build with the packet builder

Methods

impl PacketBuilderStep<Ethernet2Header>

pub fn ipv4(     self,     source: [u8; 4],     destination: [u8; 4],     time_to_live: u8 ) -> PacketBuilderStep<IpHeader>

Add an ip v4 header

pub fn ip(self, ip_header: IpHeader) -> PacketBuilderStep<IpHeader>

Add an ip header (length, protocol/next_header & checksum fields will be overwritten based on the rest of the packet).

Example IPv4

let builder = PacketBuilder::
    ethernet2([1,2,3,4,5,6],
              [7,8,9,10,11,12])
   .ip(IpHeader::Version4(Ipv4Header{
        header_length: 0, //will be replaced during write
        differentiated_services_code_point: 0,
        explicit_congestion_notification: 0,
        total_length: 0, //will be replaced during write
        identification: 0,
        dont_fragment: true,
        more_fragments: false,
        fragments_offset: 0,
        time_to_live: 12,
        protocol: 0, //will be replaced during write
        header_checksum: 0, //will be replaced during write
        source: [0,1,2,3],
        destination: [4,5,6,7]
    }));

Example IPv6

let builder = PacketBuilder::
    ethernet2([1,2,3,4,5,6],
              [7,8,9,10,11,12])
   .ip(IpHeader::Version6(Ipv6Header{
        traffic_class: 0,
        flow_label: 0,
        payload_length: 0, //will be replaced during write
        next_header: 0, //will be replaced during write
        hop_limit: 4,
        source: [0;16],
        destination: [0;16]
    }));

pub fn ipv6(     self,     source: [u8; 16],     destination: [u8; 16],     hop_limit: u8 ) -> PacketBuilderStep<IpHeader>

Add an ip v6 header

pub fn vlan(self, vlan: VlanHeader) -> PacketBuilderStep<VlanHeader>

Adds a vlan tagging header with the given vlan identifier

pub fn single_vlan(self, vlan_identifier: u16) -> PacketBuilderStep<VlanHeader>

Adds a vlan tagging header with the given vlan identifier

pub fn double_vlan(     self,     outer_vlan_identifier: u16,     inner_vlan_identifier: u16 ) -> PacketBuilderStep<VlanHeader>

Adds two vlan tagging header with the given vlan identifiers (also known as double vlan tagging).

impl PacketBuilderStep<VlanHeader>

pub fn ip(self, ip_header: IpHeader) -> PacketBuilderStep<IpHeader>

Add an ip header (length, protocol/next_header & checksum fields will be overwritten based on the rest of the packet).

Example IPv4

let builder = PacketBuilder::
    ethernet2([1,2,3,4,5,6],
              [7,8,9,10,11,12])
   .ip(IpHeader::Version4(Ipv4Header{
        header_length: 0, //will be replaced during write
        differentiated_services_code_point: 0,
        explicit_congestion_notification: 0,
        total_length: 0, //will be replaced during write
        identification: 0,
        dont_fragment: true,
        more_fragments: false,
        fragments_offset: 0,
        time_to_live: 12,
        protocol: 0, //will be replaced during write
        header_checksum: 0, //will be replaced during write
        source: [0,1,2,3],
        destination: [4,5,6,7]
    }));

Example IPv6

let builder = PacketBuilder::
    ethernet2([1,2,3,4,5,6],
              [7,8,9,10,11,12])
   .ip(IpHeader::Version6(Ipv6Header{
        traffic_class: 0,
        flow_label: 0,
        payload_length: 0, //will be replaced during write
        next_header: 0, //will be replaced during write
        hop_limit: 4,
        source: [0;16],
        destination: [0;16]
    }));

pub fn ipv6(     self,     source: [u8; 16],     destination: [u8; 16],     hop_limit: u8 ) -> PacketBuilderStep<IpHeader>

Add a ip v6 header

pub fn ipv4(     self,     source: [u8; 4],     destination: [u8; 4],     time_to_live: u8 ) -> PacketBuilderStep<IpHeader>

Add a ip v4 header

impl PacketBuilderStep<IpHeader>

pub fn udp(     self,     source_port: u16,     destination_port: u16 ) -> PacketBuilderStep<UdpHeader>

impl PacketBuilderStep<UdpHeader>

pub fn write<T: Write + Sized>(     self,     writer: &mut T,     payload: &[u8] ) -> Result<(), WriteError>

Write all the headers and the payload.

pub fn size(&self, payload_size: usize) -> usize

Returns the size of the packet when it is serialized