Struct Packet 

pub struct Packet<T> { /* private fields */ }

Available on crate feature web03 only.

A typed packet of data.

Implementations

impl<T> Packet<T>

pub const fn empty() -> Self

Construct an empty package.

Examples

use musli_web::api::MessageId;
use musli_web::web::Packet;

let packet = Packet::<()>::empty();

assert!(packet.is_empty());
assert_eq!(packet.id(), MessageId::EMPTY);

pub fn new(raw: RawPacket) -> Self

Construct a new typed package from a raw one.

Note that this does not guarantee that the typed package is correct, but the T parameter becomes associated with it allowing it to be used automatically with methods such as Packet::decode.

pub fn into_raw(self) -> RawPacket

Convert a packet into a raw packet.

To determine which endpoint or broadcast it belongs to the RawPacket::id method can be used.

pub fn is_empty(&self) -> bool

Check if the packet is empty.

Examples

use musli_web::web::Packet;

let packet = Packet::<()>::empty();
assert!(packet.is_empty());

pub fn id(&self) -> MessageId

The id of the packet this is a response to as specified by Endpoint::ID or Broadcast::ID.

impl<T> Packet<T>

where T: Decodable,

pub fn decode(&self) -> Result<T::Type<'_>, Error>

Decode the contents of a packet.

This can be called multiple times if there are multiple payloads in sequence of the response.

You can check if the packet is empty using Packet::is_empty.

pub fn decode_any<'de, R>(&'de self) -> Result<R, Error>

where R: Decode<'de, Binary, Global>,

Decode any contents of a packet.

This can be called multiple times if there are multiple payloads in sequence of the response.

You can check if the packet is empty using Packet::is_empty.

impl<T> Packet<T>

where T: Endpoint,

pub fn decode_response(&self) -> Result<T::Response<'_>, Error>

Decode the contents of a packet.

This can be called multiple times if there are multiple payloads in sequence of the response.

You can check if the packet is empty using Packet::is_empty.

pub fn decode_any_response<'de, R>(&'de self) -> Result<R, Error>

where R: Decode<'de, Binary, Global>,

Decode any contents of a packet.

This can be called multiple times if there are multiple payloads in sequence of the response.

You can check if the packet is empty using Packet::is_empty.

impl<T> Packet<T>

where T: Broadcast,

pub fn decode_event<'de>(&'de self) -> Result<T::Event<'de>, Error>

where T: BroadcastWithEvent,

Decode the primary event related to a broadcast.

pub fn decode_event_any<'de, E>(&'de self) -> Result<E, Error>

where E: Event<Broadcast = T> + Decode<'de, Binary, Global>,

Decode any event related to a broadcast.

Trait Implementations

impl<T: Clone> Clone for Packet<T>

fn clone(&self) -> Packet<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.