Struct serenity::builder::EditChannel

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

A builder to edit a GuildChannel for use via GuildChannel::edit

Defaults are not directly provided by the builder itself.

Examples

Edit a channel, providing a new name and topic:

// assuming a channel has already been bound
if let Err(why) = channel::edit(|c| c.name("new name").topic("a test topic")) {
    // properly handle the error
}

Methods

impl EditChannel

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

The bitrate of the channel in bits.

This is for voice channels only.

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

The name of the channel.

Must be between 2 and 100 characters long.

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

The position of the channel in the channel list.

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

The topic of the channel. Can be empty.

Must be between 0 and 1024 characters long.

This is for text channels only.

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

Is the channel inappropriate for work?

This is for text channels only.

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

The number of users that may be in the channel simultaneously.

This is for voice channels only.

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

The parent category of the channel.

This is for text and voice channels only.

pub fn slow_mode_rate(&mut self, seconds: u64) -> &mut Self

The seconds a user has to wait before sending another message.

Info: Only values from 0 to 120 are valid.

Trait Implementations

impl Default for EditChannel

fn default() -> EditChannel

Returns the "default value" for a type.

impl Clone for EditChannel

fn clone(&self) -> EditChannel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EditChannel

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

Formats the value using the given formatter.