Struct ServerSync

pub struct ServerSync {
    pub session: Option<u32>,
    pub max_bandwidth: Option<u32>,
    pub welcome_text: Option<String>,
    pub permissions: Option<u64>,
}

ServerSync message is sent by the server when it has authenticated the user and finished synchronizing the server state.

Fields

session: Option<u32>

The session of the current user.

max_bandwidth: Option<u32>

Maximum bandwidth that the user should use.

welcome_text: Option<String>

Server welcome text.

permissions: Option<u64>

Current user permissions in the root channel. Note: The permissions data type usually is uin32 (e.g. in PermissionQuery and PermissionDenied messages). Here it is uint64 because of an oversight in the past. Nonetheless it should never exceed the uin32 range. See also: https://github.com/mumble-voip/mumble/issues/5139

Implementations

impl ServerSync

pub fn session(&self) -> u32

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

pub fn max_bandwidth(&self) -> u32

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

pub fn welcome_text(&self) -> &str

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

pub fn permissions(&self) -> u64

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

Trait Implementations

impl Clone for ServerSync

fn clone(&self) -> ServerSync

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerSync

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

Formats the value using the given formatter.

impl Default for ServerSync

fn default() -> Self

Returns the “default value” for a type.

impl Message for ServerSync

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 ServerSync

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