Struct livekit_protocol::UserPacket

pub struct UserPacket {
    pub participant_sid: String,
    pub participant_identity: String,
    pub payload: Vec<u8>,
    pub destination_sids: Vec<String>,
    pub destination_identities: Vec<String>,
    pub topic: Option<String>,
    pub id: Option<String>,
    pub start_time: Option<u64>,
    pub end_time: Option<u64>,
}

Fields

participant_sid: String

👎Deprecated

participant ID of user that sent the message

participant_identity: String

👎Deprecated

payload: Vec<u8>

user defined payload

destination_sids: Vec<String>

👎Deprecated

the ID of the participants who will receive the message (sent to all by default)

destination_identities: Vec<String>

👎Deprecated

identities of participants who will receive the message (sent to all by default)

topic: Option<String>

topic under which the message was published

id: Option<String>

Unique ID to indentify the message

start_time: Option<u64>

start and end time allow relating the message to specific media time

end_time: Option<u64>

Implementations

impl UserPacket

pub fn topic(&self) -> &str

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

pub fn id(&self) -> &str

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

pub fn start_time(&self) -> u64

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

pub fn end_time(&self) -> u64

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

Trait Implementations

impl Clone for UserPacket

fn clone(&self) -> UserPacket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserPacket

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

Formats the value using the given formatter.

impl Default for UserPacket

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserPacket

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for UserPacket

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for UserPacket

fn eq(&self, other: &UserPacket) -> 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 Serialize for UserPacket

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UserPacket