Struct PluginDataTransmission 

pub struct PluginDataTransmission {
    pub sender_session: Option<u32>,
    pub receiver_sessions: Vec<u32>,
    pub data: Option<Vec<u8>>,
    pub data_id: Option<String>,
}

Used to send plugin messages between clients

Fields

sender_session: Option<u32>

The session ID of the client this message was sent from

receiver_sessions: Vec<u32>

The session IDs of the clients that should receive this message

data: Option<Vec<u8>>

The data that is sent

data_id: Option<String>

The ID of the sent data. This will be used by plugins to check whether they will process it or not

Implementations

impl PluginDataTransmission

pub fn sender_session(&self) -> u32

Returns the value of sender_session, or the default value if sender_session is unset.

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

Returns the value of data, or the default value if data is unset.

pub fn data_id(&self) -> &str

Returns the value of data_id, or the default value if data_id is unset.

Trait Implementations

impl Clone for PluginDataTransmission

fn clone(&self) -> PluginDataTransmission

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginDataTransmission

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

Formats the value using the given formatter.

impl Default for PluginDataTransmission

fn default() -> Self

Returns the “default value” for a type.

impl Message for PluginDataTransmission

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PluginDataTransmission

fn eq(&self, other: &PluginDataTransmission) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PluginDataTransmission