Struct smoltcp::wire::Icmpv6Packet

pub struct Icmpv6Packet<T: AsRef<[u8]>> { /* private fields */ }

A read/write wrapper around an Internet Control Message Protocol version 6 packet buffer.

Implementations

impl<T: AsRef<[u8]>> Packet<T>

pub fn new_unchecked(buffer: T) -> Packet<T>

Imbue a raw octet buffer with ICMPv6 packet structure.

pub fn new_checked(buffer: T) -> Result<Packet<T>>

Shorthand for a combination of new_unchecked and check_len.

pub fn check_len(&self) -> Result<()>

Ensure that no accessor method will panic if called. Returns Err(Error::Truncated) if the buffer is too short.

pub fn into_inner(self) -> T

Consume the packet, returning the underlying buffer.

pub fn msg_type(&self) -> Message

Return the message type field.

pub fn msg_code(&self) -> u8

Return the message code field.

pub fn checksum(&self) -> u16

Return the checksum field.

pub fn echo_ident(&self) -> u16

Return the identifier field (for echo request and reply packets).

pub fn echo_seq_no(&self) -> u16

Return the sequence number field (for echo request and reply packets).

pub fn pkt_too_big_mtu(&self) -> u32

Return the MTU field (for packet too big messages).

pub fn param_problem_ptr(&self) -> u32

Return the pointer field (for parameter problem messages).

pub fn header_len(&self) -> usize

Return the header length. The result depends on the value of the message type field.

pub fn verify_checksum(&self, src_addr: &IpAddress, dst_addr: &IpAddress) -> bool

Validate the header checksum.

Fuzzing

This function always returns true when fuzzing.

impl<'a, T: AsRef<[u8]> + ?Sized> Packet<&'a T>

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

Return a pointer to the type-specific data.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

pub fn set_msg_type(&mut self, value: Message)

Set the message type field.

pub fn set_msg_code(&mut self, value: u8)

Set the message code field.

pub fn clear_reserved(&mut self)

Clear any reserved fields in the message header.

Panics

This function panics if the message type has not been set. See set_msg_type.

pub fn set_checksum(&mut self, value: u16)

pub fn set_echo_ident(&mut self, value: u16)

Set the identifier field (for echo request and reply packets).

Panics

This function may panic if this packet is not an echo request or reply packet.

pub fn set_echo_seq_no(&mut self, value: u16)

Set the sequence number field (for echo request and reply packets).

Panics

This function may panic if this packet is not an echo request or reply packet.

pub fn set_pkt_too_big_mtu(&mut self, value: u32)

Set the MTU field (for packet too big messages).

Panics

This function may panic if this packet is not an packet too big packet.

pub fn set_param_problem_ptr(&mut self, value: u32)

Set the pointer field (for parameter problem messages).

Panics

This function may panic if this packet is not a parameter problem message.

pub fn fill_checksum(&mut self, src_addr: &IpAddress, dst_addr: &IpAddress)

Compute and fill in the header checksum.

pub fn payload_mut(&mut self) -> &mut [u8]

Return a mutable pointer to the type-specific data.

impl<T: AsRef<[u8]>> Packet<T>

Getters for the Router Advertisement message header. See RFC 4861 § 4.2.

pub fn current_hop_limit(&self) -> u8

Return the current hop limit field.

pub fn router_flags(&self) -> RouterFlags

Return the Router Advertisement flags.

pub fn router_lifetime(&self) -> Duration

Return the router lifetime field.

pub fn reachable_time(&self) -> Duration

Return the reachable time field.

pub fn retrans_time(&self) -> Duration

Return the retransmit time field.

impl<T: AsRef<[u8]>> Packet<T>

Common getters for the Neighbor Solicitation, Neighbor Advertisement, and Redirect message types.

pub fn target_addr(&self) -> Ipv6Address

Return the target address field.

impl<T: AsRef<[u8]>> Packet<T>

Getters for the Neighbor Solicitation message header. See RFC 4861 § 4.3.

pub fn neighbor_flags(&self) -> NeighborFlags

Return the Neighbor Solicitation flags.

impl<T: AsRef<[u8]>> Packet<T>

Getters for the Redirect message header. See RFC 4861 § 4.5.

pub fn dest_addr(&self) -> Ipv6Address

Return the destination address field.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

Setters for the Router Advertisement message header. See RFC 4861 § 4.2.

pub fn set_current_hop_limit(&mut self, value: u8)

Set the current hop limit field.

pub fn set_router_flags(&mut self, flags: RouterFlags)

Set the Router Advertisement flags.

pub fn set_router_lifetime(&mut self, value: Duration)

Set the router lifetime field.

pub fn set_reachable_time(&mut self, value: Duration)

Set the reachable time field.

pub fn set_retrans_time(&mut self, value: Duration)

Set the retransmit time field.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

Common setters for the Neighbor Solicitation, Neighbor Advertisement, and Redirect message types.

pub fn set_target_addr(&mut self, value: Ipv6Address)

Set the target address field.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

Setters for the Neighbor Solicitation message header. See RFC 4861 § 4.3.

pub fn set_neighbor_flags(&mut self, flags: NeighborFlags)

Set the Neighbor Solicitation flags.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

Setters for the Redirect message header. See RFC 4861 § 4.5.

pub fn set_dest_addr(&mut self, value: Ipv6Address)

Set the destination address field.

impl<T: AsRef<[u8]>> Packet<T>

Getters for the Multicast Listener Query message header. See RFC 3810 § 5.1.

pub fn max_resp_code(&self) -> u16

Return the maximum response code field.

pub fn mcast_addr(&self) -> Ipv6Address

Return the address being queried.

pub fn s_flag(&self) -> bool

Return the Suppress Router-Side Processing flag.

pub fn qrv(&self) -> u8

Return the Querier’s Robustness Variable.

pub fn qqic(&self) -> u8

Return the Querier’s Query Interval Code.

pub fn num_srcs(&self) -> u16

Return number of sources.

impl<T: AsRef<[u8]>> Packet<T>

Getters for the Multicast Listener Report message header. See RFC 3810 § 5.2.

pub fn nr_mcast_addr_rcrds(&self) -> u16

Return the number of Multicast Address Records.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

Setters for the Multicast Listener Query message header. See RFC 3810 § 5.1.

pub fn set_max_resp_code(&mut self, code: u16)

Set the maximum response code field.

pub fn set_mcast_addr(&mut self, addr: Ipv6Address)

Set the address being queried.

pub fn set_s_flag(&mut self)

Set the Suppress Router-Side Processing flag.

pub fn clear_s_flag(&mut self)

Clear the Suppress Router-Side Processing flag.

pub fn set_qrv(&mut self, value: u8)

Set the Querier’s Robustness Variable.

pub fn set_qqic(&mut self, value: u8)

Set the Querier’s Query Interval Code.

pub fn set_num_srcs(&mut self, value: u16)

Set number of sources.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

Setters for the Multicast Listener Report message header. See RFC 3810 § 5.2.

pub fn set_nr_mcast_addr_rcrds(&mut self, value: u16)

Set the number of Multicast Address Records.

Trait Implementations

impl<T: AsRef<[u8]>> AsRef<[u8]> for Packet<T>

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

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone + AsRef<[u8]>> Clone for Packet<T>

fn clone(&self) -> Packet<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + AsRef<[u8]>> Debug for Packet<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + AsRef<[u8]>> PartialEq<Packet<T>> for Packet<T>

fn eq(&self, other: &Packet<T>) -> bool

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

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

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

impl<T: AsRef<[u8]>> StructuralPartialEq for Packet<T>