Struct Channel

pub struct Channel {
    pub id: Option<Snowflake>,
    pub guild_id: Option<Snowflake>,
    pub name: Option<String>,
    pub channel_type: Option<ChannelType>,
    pub sub_type: Option<ChannelSubType>,
    pub position: Option<i32>,
    pub parent_id: Option<Snowflake>,
    pub owner_id: Option<Snowflake>,
    pub private_type: Option<PrivateType>,
    pub speak_permission: Option<SpeakPermission>,
    pub application_id: Option<Snowflake>,
    pub permissions: Option<String>,
}

Represents a channel in a guild.

Fields

id: Option<Snowflake>

The channel’s unique ID

guild_id: Option<Snowflake>

The guild ID this channel belongs to

name: Option<String>

The channel’s name

channel_type: Option<ChannelType>

The type of channel

sub_type: Option<ChannelSubType>

The subtype of channel

position: Option<i32>

The position of this channel in the channel list

parent_id: Option<Snowflake>

The ID of the parent category

owner_id: Option<Snowflake>

The ID of the channel owner

private_type: Option<PrivateType>

The private type of the channel

speak_permission: Option<SpeakPermission>

The speak permission setting

application_id: Option<Snowflake>

The application ID for application channels

permissions: Option<String>

The permissions string

Implementations

impl Channel

pub fn new() -> Self

Creates a new channel.

pub fn from_data(_api: BotApi, id: String, data: Value) -> Self

Creates a new channel from API data.

pub fn mention(&self) -> String

Gets the channel’s mention string.

pub fn is_text(&self) -> bool

Returns true if this is a text channel.

pub fn is_voice(&self) -> bool

Returns true if this is a voice channel.

pub fn is_group(&self) -> bool

Returns true if this is a group channel (category).

pub fn is_live(&self) -> bool

Returns true if this is a live channel.

pub fn is_application(&self) -> bool

Returns true if this is an application channel.

pub fn is_discussion(&self) -> bool

Returns true if this is a discussion (forum) channel.

pub fn is_public(&self) -> bool

Returns true if the channel is public.

pub fn is_admin_only(&self) -> bool

Returns true if the channel is private (admin only).

pub fn is_specified_users_only(&self) -> bool

Returns true if the channel is for specified users only.

pub fn everyone_can_speak(&self) -> bool

Returns true if everyone can speak in this channel.

pub fn admin_only_speak(&self) -> bool

Returns true if only admins can speak in this channel.

pub fn display_name(&self) -> Option<&str>

Gets the channel’s display name (same as name for channels).

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.

impl Default for Channel

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Channel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasId for Channel

fn id(&self) -> Option<&Snowflake>

Returns the object’s ID, or None if not set.

fn id_string(&self) -> String

Returns the object’s ID as a string, or empty string if not set.

impl HasName for Channel

fn name(&self) -> &str

Returns the object’s name.

impl PartialEq for Channel

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

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 Channel