Struct Ipv4PacketBuilderWithOptions

pub struct Ipv4PacketBuilderWithOptions<'a, I> { /* private fields */ }

A PacketBuilder for Ipv4 Packets but with options.

Implementations

impl<'a, I> Ipv4PacketBuilderWithOptions<'a, I>

where I: Iterator + Clone, I::Item: Borrow<Ipv4Option<'a>>,

pub fn new<T: IntoIterator<IntoIter = I>>( prefix_builder: Ipv4PacketBuilder, options: T, ) -> Result<Ipv4PacketBuilderWithOptions<'a, I>, Ipv4OptionsTooLongError>

Creates a new IPv4 packet builder without options.

Returns Err if the packet header would exceed the maximum length of MAX_HDR_LEN. This happens if the options, when serialized, would exceed MAX_OPTIONS_LEN.

pub fn prefix_builder(&self) -> &Ipv4PacketBuilder

Returns a reference to the prefix builder.

pub fn prefix_builder_mut(&mut self) -> &mut Ipv4PacketBuilder

Returns a mutable reference to the prefix builder.

pub fn options(&self) -> &I

Returns a reference to the options used to create this builder.

pub fn with_fragment_options( self, first_fragment: bool, ) -> Ipv4PacketBuilderWithOptions<'a, impl Iterator<Item: Borrow<Ipv4Option<'a>>> + Clone>

Maps this builder optionally maintaining only the options that are meant to be copied on all fragments.

If first_fragment is true, all options are maintained, otherwise only the options meant to be copied on all fragments will be yielded.

impl<'a, B> Ipv4PacketBuilderWithOptions<'a, RecordsIter<'a, B, Ipv4OptionsImpl>>

pub fn new_with_records_iter( prefix_builder: Ipv4PacketBuilder, iter: RecordsIter<'a, B, Ipv4OptionsImpl>, ) -> Self

Creates a new Ipv4PacketBuilderWithOptions with a known-to-be-valid iterator of IPv4 options records.

Trait Implementations

impl<'a, I: Clone> Clone for Ipv4PacketBuilderWithOptions<'a, I>

fn clone(&self) -> Ipv4PacketBuilderWithOptions<'a, I>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, I: Debug> Debug for Ipv4PacketBuilderWithOptions<'a, I>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, Item> IpPacketBuilder<Ipv4> for Ipv4PacketBuilderWithOptions<'a, Iter<'a, Item>>

where Item: Debug, &'a Item: Borrow<Ipv4Option<'a>>,

fn new(src_ip: Ipv4Addr, dst_ip: Ipv4Addr, ttl: u8, proto: Ipv4Proto) -> Self

Returns a new packet builder for an associated IP version with the given given source and destination IP addresses, TTL (IPv4)/Hop Limit (IPv4) and Protocol Number.

fn src_ip(&self) -> Ipv4Addr

Returns the source IP address for the builder.

fn set_src_ip(&mut self, addr: Ipv4Addr)

Sets the source IP address for the builder.

fn dst_ip(&self) -> Ipv4Addr

Returns the destination IP address for the builder.

fn set_dst_ip(&mut self, addr: Ipv4Addr)

Sets the destination IP address for the builder.

fn proto(&self) -> Ipv4Proto

Returns the IP protocol number for the builder.

fn set_dscp_and_ecn(&mut self, dscp_and_ecn: DscpAndEcn)

Set DSCP & ECN fields.

impl<'a, I> PacketBuilder for Ipv4PacketBuilderWithOptions<'a, I>

where I: Iterator + Clone, I::Item: Borrow<Ipv4Option<'a>>,

fn constraints(&self) -> PacketConstraints

Gets the constraints for this PacketBuilder.

fn serialize( &self, target: &mut SerializeTarget<'_>, body: FragmentedBytesMut<'_, '_>, )

Serializes this packet into an existing buffer.