Struct MutableVrrpPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableVrrpPacket<'a>

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

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

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

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

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

Maps from a MutableVrrpPacket to a VrrpPacket

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

Maps from a MutableVrrpPacket to a VrrpPacket 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: &Vrrp) -> usize

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

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

Populates a VrrpPacket using a Vrrp structure

pub fn get_version(&self) -> u4

Get the version field.

pub fn get_header_type(&self) -> u4

Get the header_type field.

pub fn get_vrid(&self) -> u8

Get the vrid field.

pub fn get_priority(&self) -> u8

Get the priority field.

pub fn get_count_ip(&self) -> u8

Get the count_ip field.

pub fn get_auth_type(&self) -> u8

Get the auth_type field.

pub fn get_advert_int(&self) -> u8

Get the advert_int field.

pub fn get_checksum(&self) -> u16be

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

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

Get the raw &u8 value of the ip_addresses field, without copying

pub fn get_ip_addresses(&self) -> Vec<u8>

Get the value of the ip_addresses field (copies contents)

pub fn get_auth_data(&self) -> u32be

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

pub fn get_auth_data2(&self) -> u32be

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

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

Set the version field.

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

Set the header_type field.

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

Set the vrid field.

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

Set the priority field.

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

Set the count_ip field.

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

Set the auth_type field.

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

Set the advert_int field.

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

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

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

Get the raw &mut u8 value of the ip_addresses field, without copying

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

Set the value of the ip_addresses field (copies contents)

pub fn set_auth_data(&mut self, val: u32be)

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

pub fn set_auth_data2(&mut self, val: u32be)

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

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

Set the value of the payload field (copies contents)

Trait Implementations

impl<'p> Debug for MutableVrrpPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableVrrpPacket<'p>

type T = Vrrp

The type of the packet to convert from.

fn from_packet(&self) -> Vrrp

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

impl<'a> MutablePacket for MutableVrrpPacket<'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 MutableVrrpPacket<'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 MutableVrrpPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for MutableVrrpPacket<'p>

fn eq(&self, other: &MutableVrrpPacket<'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 MutableVrrpPacket<'p>