Struct MutableIpv6Packet

pub struct MutableIpv6Packet<'p> { /* private fields */ }

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableIpv6Packet<'a>

pub fn new<'p>(packet: &'p mut [u8]) -> Option<MutableIpv6Packet<'p>>

Constructs a new MutableIpv6Packet. If the provided buffer is less than the minimum required packet size, this will return None.

pub fn owned(packet: Vec<u8>) -> Option<MutableIpv6Packet<'static>>

Constructs a new MutableIpv6Packet. If the provided buffer is less than the minimum required packet size, this will return None. With this constructor the MutableIpv6Packet will own its own data and the underlying buffer will be dropped when the MutableIpv6Packet is.

pub fn to_immutable<'p>(&'p self) -> Ipv6Packet<'p>

Maps from a MutableIpv6Packet to a Ipv6Packet

pub fn consume_to_immutable(self) -> Ipv6Packet<'a>

Maps from a MutableIpv6Packet to a Ipv6Packet while consuming the source

pub const 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.

pub fn packet_size(_packet: &Ipv6) -> usize

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

pub fn populate(&mut self, packet: &Ipv6)

Populates a Ipv6Packet using a Ipv6 structure

pub fn get_version(&self) -> u4

Get the version field.

pub fn get_traffic_class(&self) -> u8

Get the traffic_class field.

pub fn get_flow_label(&self) -> u20be

Get the flow_label field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_payload_length(&self) -> u16be

Get the payload_length field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_next_header(&self) -> IpNextLevelProtocol

Get the value of the next_header field

pub fn get_hop_limit(&self) -> u8

Get the hop_limit field.

pub fn get_source(&self) -> Ipv6Addr

Get the value of the source field

pub fn get_destination(&self) -> Ipv6Addr

Get the value of the destination field

pub fn set_version(&mut self, val: u4)

Set the version field.

pub fn set_traffic_class(&mut self, val: u8)

Set the traffic_class field.

pub fn set_flow_label(&mut self, val: u20be)

Set the flow_label field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_payload_length(&mut self, val: u16be)

Set the payload_length field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_next_header(&mut self, val: IpNextLevelProtocol)

Set the value of the next_header field.

pub fn set_hop_limit(&mut self, val: u8)

Set the hop_limit field.

pub fn set_source(&mut self, val: Ipv6Addr)

Set the value of the source field.

pub fn set_destination(&mut self, val: Ipv6Addr)

Set the value of the destination field.

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

Set the value of the payload field (copies contents)

Trait Implementations

impl<'p> Debug for MutableIpv6Packet<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableIpv6Packet<'p>

type T = Ipv6

The type of the packet to convert from.

fn from_packet(&self) -> Ipv6

Converts a wire-format packet to #[packet] struct format.

impl<'a> MutablePacket for MutableIpv6Packet<'a>

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

Retrieve the underlying, mutable, buffer for the packet.

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

Retrieve the mutable payload for the packet.

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

where T: Packet,

Initialize this packet by cloning another.

impl<'a> Packet for MutableIpv6Packet<'a>

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

Retrieve the underlying buffer for the packet.

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

Retrieve the payload for the packet.

impl<'a> PacketSize for MutableIpv6Packet<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for MutableIpv6Packet<'p>

fn eq(&self, other: &MutableIpv6Packet<'p>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'p> StructuralPartialEq for MutableIpv6Packet<'p>