Struct serenity::model::channel::ChannelCategory

pub struct ChannelCategory {
    pub id: ChannelId,
    pub guild_id: GuildId,
    pub category_id: Option<ChannelId>,
    pub position: i64,
    pub kind: ChannelType,
    pub name: String,
    pub nsfw: bool,
    pub permission_overwrites: Vec<PermissionOverwrite>,
    // some fields omitted
}

A category of GuildChannels.

Fields

id: ChannelId

Id of this category.

guild_id: GuildId

Guild Id this category belongs to.

category_id: Option<ChannelId>

If this category belongs to another category.

position: i64

The position of this category.

kind: ChannelType

Indicator of the type of channel this is.

This should always be ChannelType::Category.

name: String

The name of the category.

nsfw: bool

Whether this category is nsfw. (This'll be inherited by all channels in this category)

permission_overwrites: Vec<PermissionOverwrite>

Permission overwrites for the GuildChannels.

Implementations

impl ChannelCategory

pub async fn create_permission<'_, '_>(
    &'_ self,
    http: impl AsRef<Http>,
    target: &'_ PermissionOverwrite
) -> Result<()>

Adds a permission overwrite to the category's channels.

pub async fn delete_permission<'_>(
    &'_ self,
    http: impl AsRef<Http>,
    permission_type: PermissionOverwriteType
) -> Result<()>

Deletes all permission overrides in the category from the channels.

Note: Requires the Manage Channel permission.

pub async fn delete<'_>(&'_ self, cache_http: impl CacheHttp) -> Result<()>

Deletes this category if required permissions are met.

pub async fn edit<F, '_>(
    &'_ mut self,
    cache_http: impl CacheHttp,
    f: F
) -> Result<()> where
    F: FnOnce(&mut EditChannel) -> &mut EditChannel, 

Modifies the category's settings, such as its position or name.

Refer to EditChannels documentation for a full list of methods.

Examples

Change a voice channels name and bitrate:

category.edit(&http, |c| c.name("test").bitrate(86400)).await;

pub fn is_nsfw(&self) -> bool

pub fn name(&self) -> &str

Returns the name of the category.

Trait Implementations

impl Clone for ChannelCategory

fn clone(&self) -> ChannelCategory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelCategory

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelCategory

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Mentionable for ChannelCategory

fn mention(&self) -> String

Creates a mentionable string, that will be able to notify and/or create a link to the item.

impl Serialize for ChannelCategory

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.