Struct MutableHandshakePacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableHandshakePacket<'a>

pub fn new<'p>(packet: &'p mut [u8]) -> Option<MutableHandshakePacket<'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<MutableHandshakePacket<'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) -> HandshakePacket<'p>

Maps from a #name to a #imm_name

pub fn consume_to_immutable(self) -> HandshakePacket<'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: &Handshake) -> usize

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

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

Populates a {name}Packet using a {name} structure

pub fn get_header_form(&self) -> HeaderForm

Get the value of the {name} field

pub fn get_fixed_bit(&self) -> FixedBit

Get the value of the {name} field

pub fn get_long_packet_type(&self) -> LongPacketType

Get the value of the {name} field

pub fn get_reserved(&self) -> u2

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

pub fn get_packet_number_len(&self) -> u2

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

pub fn get_version(&self) -> Version

Get the value of the {name} field

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_length_raw(&self) -> &[u8]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn set_header_form(&mut self, val: HeaderForm)

Set the value of the {name} field.

pub fn set_fixed_bit(&mut self, val: FixedBit)

Set the value of the {name} field.

pub fn set_long_packet_type(&mut self, val: LongPacketType)

Set the value of the {name} field.

pub fn set_reserved(&mut self, val: u2)

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

pub fn set_packet_number_len(&mut self, val: u2)

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

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

Set the value of the {name} field.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl<'p> Debug for MutableHandshakePacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableHandshakePacket<'p>

type T = Handshake

The type of the packet to convert from.

fn from_packet(&self) -> Handshake

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

impl<'a> MutablePacket for MutableHandshakePacket<'a>

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

Retreive the underlying, mutable, buffer for the packet.

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

Retreive 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 MutableHandshakePacket<'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 MutableHandshakePacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for MutableHandshakePacket<'p>

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