Struct discortp::discord::IpDiscoveryPacket

pub struct IpDiscoveryPacket<'p> { /* fields omitted */ }

A structure enabling manipulation of on the wire packets

Methods

impl<'a> IpDiscoveryPacket<'a>

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

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

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

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

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

Maps from a IpDiscoveryPacket to a IpDiscoveryPacket

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

Maps from a IpDiscoveryPacket to a IpDiscoveryPacket 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: &IpDiscovery) -> usize

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

pub fn get_pkt_type(&self) -> IpDiscoveryType

Get the value of the pkt_type field

pub fn get_length(&self) -> u16be

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

pub fn get_ssrc(&self) -> u32be

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

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

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

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

Get the value of the address field (copies contents)

pub fn get_port(&self) -> u16be

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

impl<'_> IpDiscoveryPacket<'_>

pub const fn const_packet_size() -> usize

Standard packet length when using Discord-specified lengths.

Trait Implementations

impl<'p> Debug for IpDiscoveryPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for IpDiscoveryPacket<'p>

type T = IpDiscovery

The type of the packet to convert from.

fn from_packet(&self) -> IpDiscovery

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

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

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<IpDiscoveryPacket<'p>> for IpDiscoveryPacket<'p>

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

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

fn ne(&self, other: &IpDiscoveryPacket<'p>) -> bool

This method tests for !=.

impl<'p> StructuralPartialEq for IpDiscoveryPacket<'p>