Struct PacketEvent 

pub struct PacketEvent {
    pub channel: String,
    pub player: String,
    pub payload: Vec<u8>,
}

A packet the server or the client received (on_packet / on_client_packet). A packet a client sent on a mod’s channel; keyed by the channel.

Fields

channel: String

The channel (mymod:sync).

player: String

The sender’s name.

payload: Vec<u8>

The bytes as the mod wrote them.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl Event for Packet

const ADDRESS: &'static str = ids::event_server_net::PACKET

Where it’s emitted after the game did it.

const PRE: Option<&'static str> = None

Where it’s emitted before — a handler’s cancel stops it — if it can be stopped.

const KEY: Option<&'static str>

The field whose value picks the event’s branch (entity_type: each type’s ticks go to …/tick/<type>), if it’s keyed — see crate::keyed.

fn key(&self) -> Option<&str>

The key field’s value, if it’s keyed.

fn address(&self) -> u32

Event::target’s number — the type’s own address cached.

fn pre_address(&self) -> Option<u32>

Event::pre_target’s number.

fn target(&self) -> String

Where this event goes after the game did it: the address, or its branch for the key.

fn pre_target(&self) -> Option<String>

Where it goes before, if it can be stopped.

impl Fields for Packet

const FIELDS: &'static [(&'static str, &'static str)]

impl Schema for Packet

fn encode(&self, __yog_w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).

fn decode(__yog_d: &mut Decoder<'_>) -> Option<Packet>

Reads itself from the binary form, straight; None when it isn’t what Schema::encode writes — then read_bytes reads the slow way, which says what’s wrong. Through a value unless the type knows better (derived ones do).

fn pack(&self, __yog_p: &mut Packer)

Packs itself into a frame (crate::frame): its binary form as bytes, unless the type packs itself (derived ones and plain types do).

fn unpack(__yog_u: &mut Unpacker<'_>) -> Option<Packet>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.

fn shape() -> Shape

What the format looks like.

fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<Packet>

Reads v. Problems go to cx at its current path; None when the value couldn’t be read (the problem is in cx).

fn write(&self) -> Value

The value, as the format writes it.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.