Struct serenity::builder::CreateChannel

pub struct CreateChannel(pub HashMap<&'static str, Value>);

A builder for creating a new GuildChannel in a Guild.

Except Self::name, all fields are optional.

Implementations

impl CreateChannel

pub fn name<D: ToString>(&mut self, name: D) -> &mut Self

Specify how to call this new channel.

Note: Must be between 2 and 100 characters long.

pub fn kind(&mut self, kind: ChannelType) -> &mut Self

Specify what type the channel is, whether it’s a text, voice, category or news channel.

pub fn category<I: Into<ChannelId>>(&mut self, id: I) -> &mut Self

Specifiy the category, the “parent” of this channel.

pub fn topic<D: ToString>(&mut self, topic: D) -> &mut Self

Set an interesting topic.

Note: Must be between 0 and 1000 characters long.

pub fn nsfw(&mut self, b: bool) -> &mut Self

Specify if this channel will be inappropriate to browse while at work.

pub fn bitrate(&mut self, rate: u32) -> &mut Self

[Voice-only] Specify the bitrate at which sound plays in the voice channel.

pub fn user_limit(&mut self, limit: u32) -> &mut Self

[Voice-only] Set how many users may occupy this voice channel.

pub fn rate_limit(&mut self, limit: u64) -> &mut Self

How many seconds must a user wait before sending another message.

Bots, or users with the MANAGE_MESSAGES and/or MANAGE_CHANNELS permissions are exempt from this restriction.

Note: Must be between 0 and 21600 seconds (360 minutes or 6 hours).

pub fn position(&mut self, pos: u32) -> &mut Self

Specify where the channel should be located.

pub fn permissions<I>(&mut self, perms: I) -> &mut Self where
    I: IntoIterator<Item = PermissionOverwrite>, 

A set of overwrites defining what a user or a user carrying a certain role can and cannot do.

Example

Inheriting permissions from an exisiting channel:

use serenity::model::channel::{PermissionOverwrite, PermissionOverwriteType};
use serenity::model::id::UserId;
use serenity::model::permissions::Permissions;

// Assuming a guild has already been bound.
let permissions = vec![PermissionOverwrite {
    allow: Permissions::READ_MESSAGES,
    deny: Permissions::SEND_TTS_MESSAGES,
    kind: PermissionOverwriteType::Member(UserId(1234)),
}];

guild.create_channel(http, |c| {
    c.name("my_new_cool_channel")
    .permissions(permissions)
})
.await?;

Trait Implementations

impl Clone for CreateChannel

fn clone(&self) -> CreateChannel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChannel

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

Formats the value using the given formatter.

impl Default for CreateChannel

fn default() -> Self

Creates a builder with default values, setting Self::kind to ChannelType::Text.

Examples

Create a default CreateChannel builder:

use serenity::builder::CreateChannel;

let channel_builder = CreateChannel::default();