Struct discortp::discord::KeepalivePacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> KeepalivePacket<'a>

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

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

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

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

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

Maps from a KeepalivePacket to a KeepalivePacket

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

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

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

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.

Trait Implementations

impl<'p> Debug for KeepalivePacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for KeepalivePacket<'p>

type T = Keepalive

The type of the packet to convert from.

fn from_packet(&self) -> Keepalive

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

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

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for KeepalivePacket<'p>

fn eq(&self, other: &KeepalivePacket<'p>) -> 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<'p> StructuralPartialEq for KeepalivePacket<'p>