Struct Authenticate

pub struct Authenticate {
    pub username: Option<String>,
    pub password: Option<String>,
    pub tokens: Vec<String>,
    pub celt_versions: Vec<i32>,
    pub opus: Option<bool>,
    pub client_type: Option<i32>,
}

Used by the client to send the authentication credentials to the server.

Fields

username: Option<String>

UTF-8 encoded username.

password: Option<String>

Server or user password.

tokens: Vec<String>

Additional access tokens for server ACL groups.

celt_versions: Vec<i32>

A list of CELT bitstream version constants supported by the client.

opus: Option<bool>

client_type: Option<i32>

0 = REGULAR, 1 = BOT

Implementations

impl Authenticate

pub fn username(&self) -> &str

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

pub fn password(&self) -> &str

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

pub fn opus(&self) -> bool

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

pub fn client_type(&self) -> i32

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

Trait Implementations

impl Clone for Authenticate

fn clone(&self) -> Authenticate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Authenticate

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

Formats the value using the given formatter.

impl Default for Authenticate

fn default() -> Self

Returns the “default value” for a type.

impl Message for Authenticate

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 Authenticate

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