Struct blaze_pk::Packets

pub struct Packets {}

Structure for storing functions related to creation of packets

Implementations

impl Packets

pub fn response<C: Codec>(packet: &OpaquePacket, contents: &C) -> OpaquePacket

Creates a new response packet for responding to the provided decodable packet. With the contents

pub fn response_raw(packet: &OpaquePacket, contents: Vec<u8>) -> OpaquePacket

pub fn response_empty(packet: &OpaquePacket) -> OpaquePacket

Shortcut function for creating a response packet with no content

pub fn error<C: Codec>(
    packet: &OpaquePacket,
    error: impl Into<u16>,
    contents: &C
) -> OpaquePacket

Creates a new error response packet for responding to the provided packet with an error number with contents

pub fn error_empty(packet: &OpaquePacket, error: impl Into<u16>) -> OpaquePacket

Shortcut function for creating an error packet with no content

pub fn notify<C: Codec, T: PacketComponents>(
    component: T,
    contents: &C
) -> OpaquePacket

Creates a new notify packet with the provided component and command and contents

pub fn notify_raw<T: PacketComponents>(
    component: T,
    contents: Vec<u8>
) -> OpaquePacket

pub fn notify_empty<T: PacketComponents>(component: T) -> OpaquePacket

Shortcut function for creating a notify packet with no content

pub fn request<C: Codec, T: PacketComponents>(
    id: u16,
    component: T,
    contents: &C
) -> OpaquePacket

Creates a new request packet retrieving its ID from the provided request counter.

pub fn request_empty<T: PacketComponents>(id: u16, component: T) -> OpaquePacket

Creates a new request packet retrieving its ID from the provided request counter.