Struct VersionNegotiationPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> VersionNegotiationPacket<'a>

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

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

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

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

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

Maps from a #name to a #imm_name

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

Maps from a #name to a #imm_name 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: &VersionNegotiation) -> usize

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

pub fn get_header_form(&self) -> HeaderForm

Get the value of the {name} field

pub fn get_unused(&self) -> u7

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

pub fn get_version(&self) -> u32be

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

pub fn get_dest_id_len(&self) -> u8

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

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

Get the raw &u8 value of the {name} field, without copying

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

Get the value of the {name} field (copies contents)

pub fn get_src_id_len(&self) -> u8

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

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

Get the raw &u8 value of the {name} field, without copying

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

Get the value of the {name} field (copies contents)

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

Get the raw &u8 value of the {name} field, without copying

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

Get the value of the {name} field (copies contents)

Trait Implementations

impl<'p> Debug for VersionNegotiationPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for VersionNegotiationPacket<'p>

type T = VersionNegotiation

The type of the packet to convert from.

fn from_packet(&self) -> VersionNegotiation

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

impl<'a> Packet for VersionNegotiationPacket<'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 VersionNegotiationPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for VersionNegotiationPacket<'p>

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