Struct TokenSourceRequest 

pub struct TokenSourceRequest {
    pub room_name: Option<String>,
    pub participant_name: Option<String>,
    pub participant_identity: Option<String>,
    pub participant_metadata: Option<String>,
    pub participant_attributes: HashMap<String, String>,
    pub room_config: Option<RoomConfiguration>,
}

Fields

room_name: Option<String>

The name of the room being requested when generating credentials

participant_name: Option<String>

The name of the participant being requested for this client when generating credentials

participant_identity: Option<String>

The identity of the participant being requested for this client when generating credentials

participant_metadata: Option<String>

Any participant metadata being included along with the credentials generation operation

participant_attributes: HashMap<String, String>

Any participant attributes being included along with the credentials generation operation

room_config: Option<RoomConfiguration>

A RoomConfiguration object can be passed to request extra parameters should be included when generating connection credentials - dispatching agents, defining egress settings, etc More info: https://docs.livekit.io/home/get-started/authentication/#room-configuration

Implementations

impl TokenSourceRequest

pub fn room_name(&self) -> &str

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

pub fn participant_name(&self) -> &str

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

pub fn participant_identity(&self) -> &str

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

pub fn participant_metadata(&self) -> &str

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

Trait Implementations

impl Clone for TokenSourceRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenSourceRequest

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

Formats the value using the given formatter.

impl Default for TokenSourceRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenSourceRequest

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for TokenSourceRequest

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 TokenSourceRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TokenSourceRequest

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 TokenSourceRequest