Struct ChannelState

pub struct ChannelState {

    pub channel_id: Option<u32>,
    pub parent: Option<u32>,
    pub name: Option<String>,
    pub links: Vec<u32>,
    pub description: Option<String>,
    pub links_add: Vec<u32>,
    pub links_remove: Vec<u32>,
    pub temporary: Option<bool>,
    pub position: Option<i32>,
    pub description_hash: Option<Vec<u8>>,
    pub max_users: Option<u32>,
    pub is_enter_restricted: Option<bool>,
    pub can_enter: Option<bool>,
}

Used to communicate channel properties between the client and the server. Sent by the server during the login process or when channel properties are updated. Client may use this message to update said channel properties.

Fields

channel_id: Option<u32>

Unique ID for the channel within the server.

parent: Option<u32>

channel_id of the parent channel.

name: Option<String>

UTF-8 encoded channel name.

links: Vec<u32>

A collection of channel id values of the linked channels. Absent during the first channel listing.

description: Option<String>

UTF-8 encoded channel description. Only if the description is less than 128 bytes

links_add: Vec<u32>

A collection of channel_id values that should be added to links.

links_remove: Vec<u32>

A collection of channel_id values that should be removed from links.

temporary: Option<bool>

True if the channel is temporary.

position: Option<i32>

Position weight to tweak the channel position in the channel list.

description_hash: Option<Vec<u8>>

SHA1 hash of the description if the description is 128 bytes or more.

max_users: Option<u32>

Maximum number of users allowed in the channel. If this value is zero, the maximum number of users allowed in the channel is given by the server’s “usersperchannel” setting.

is_enter_restricted: Option<bool>

Whether this channel has enter restrictions (ACL denying ENTER) set

can_enter: Option<bool>

Whether the receiver of this msg is considered to be able to enter this channel

Implementations

impl ChannelState

pub fn channel_id(&self) -> u32

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

pub fn parent(&self) -> u32

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

pub fn name(&self) -> &str

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

pub fn description(&self) -> &str

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

pub fn temporary(&self) -> bool

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

pub fn position(&self) -> i32

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

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

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

pub fn max_users(&self) -> u32

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

pub fn is_enter_restricted(&self) -> bool

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

pub fn can_enter(&self) -> bool

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

Trait Implementations

impl Clone for ChannelState

fn clone(&self) -> ChannelState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelState

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

Formats the value using the given formatter.

impl Default for ChannelState

fn default() -> Self

Returns the “default value” for a type.

impl Message for ChannelState

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 ChannelState

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