Struct serenity::model::channel::ChannelCategory

#[non_exhaustive]
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>,
}

A category of GuildChannels.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

Note: Requires the Manage Channels permission.

Also requires the Manage Roles permission if not modifying the permissions for only the current user.

Errors

Returns Error::Http if the current user lacks permission, or if an invalid value was set.

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 Roles permission.

Errors

Returns Error::Http if the current user lacks permission.

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

Deletes this category.

Note: Requires the Manage Channels permission.

Errors

Returns Error::Http if the current user lacks permission.

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.

Note: Requires the Manage Channels permission, also requires the Manage Roles permission if modifying permissions for the category.

Examples

Change a voice channels name and bitrate:

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

Errors

Returns Error::Http if an invalid value is set, or if the current user lacks the necessary permissions.

pub fn is_nsfw(&self) -> bool

pub fn name(&self) -> &str

Returns the name of the category.

Trait Implementations

impl ArgumentConvert for ChannelCategory

Look up a ChannelCategory by a string case-insensitively.

Lookup is done by the global cache, hence the cache feature needs to be enabled.

For more information, see the ArgumentConvert implementation for Channel

type Err = ChannelCategoryParseError

The associated error which can be returned from parsing.

fn convert<'life0, 'life1, 'async_trait>(
    ctx: &'life0 Context,
    guild_id: Option<GuildId>,
    channel_id: Option<ChannelId>,
    s: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Err>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Parses a string s as a command parameter of this type.

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 From<&'_ ChannelCategory> for Mention

fn from(value: &ChannelCategory) -> Self

Performs the conversion.

impl Mentionable for ChannelCategory

fn mention(&self) -> Mention

Creates a Mention that will be able to notify 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.