Enum serenity::model::channel::Channel

pub enum Channel {
    Group(Arc<RwLock<Group>>),
    Guild(Arc<RwLock<GuildChannel>>),
    Private(Arc<RwLock<PrivateChannel>>),
    Category(Arc<RwLock<ChannelCategory>>),
    // some variants omitted
}

A container for any channel.

Variants

Group(Arc<RwLock<Group>>)

A group. A group comprises of only one channel.

Guild(Arc<RwLock<GuildChannel>>)

A text or voice channel within a Guild.

Private(Arc<RwLock<PrivateChannel>>)

A private channel to another User. No other users may access the channel. For multi-user "private channels", use a group.

Category(Arc<RwLock<ChannelCategory>>)

A category of GuildChannels

Implementations

impl Channel

pub fn group(self) -> Option<Arc<RwLock<Group>>>

Converts from Channel to Option<Arc<RwLock<Group>>>.

Converts self into an Option<Arc<RwLock<Group>>>, consuming self, and discarding a GuildChannel, PrivateChannel, or ChannelCategory, if any.

Examples

Basic usage:

match channel.group() {
    Some(group_lock) => {
        if let Some(ref name) = group_lock.read().name {
            println!("It's a group named {}!", name);
        } else {
             println!("It's an unnamed group!");
        }
    },
    None => { println!("It's not a group!"); },
}
fn main() {}

pub fn guild(self) -> Option<Arc<RwLock<GuildChannel>>>

Converts from Channel to Option<Arc<RwLock<GuildChannel>>>.

Converts self into an Option<Arc<RwLock<GuildChannel>>>, consuming self, and discarding a Group, PrivateChannel, or ChannelCategory, if any.

Examples

Basic usage:

match channel.guild() {
    Some(guild_lock) => {
        println!("It's a guild named {}!", guild_lock.read().name);
    },
    None => { println!("It's not a guild!"); },
}
fn main() {}

pub fn private(self) -> Option<Arc<RwLock<PrivateChannel>>>

Converts from Channel to Option<Arc<RwLock<PrivateChannel>>>.

Converts self into an Option<Arc<RwLock<PrivateChannel>>>, consuming self, and discarding a Group, GuildChannel, or ChannelCategory, if any.

Examples

Basic usage:

match channel.private() {
    Some(private_lock) => {
        let private = private_lock.read();
        let recipient_lock = &private.recipient;
        let recipient = recipient_lock.read();
        println!("It's a private channel with {}!", recipient.name);
    },
    None => { println!("It's not a private channel!"); },
}
fn main() {}

pub fn category(self) -> Option<Arc<RwLock<ChannelCategory>>>

Converts from Channel to Option<Arc<RwLock<ChannelCategory>>>.

Converts self into an Option<Arc<RwLock<ChannelCategory>>>, consuming self, and discarding a Group, GuildChannel, or PrivateChannel, if any.

Examples

Basic usage:

match channel.category() {
    Some(category_lock) => {
        println!("It's a category named {}!", category_lock.read().name);
    },
    None => { println!("It's not a category!"); },
}
fn main() {}

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

Deletes the inner channel.

Note: If the cache-feature is enabled permissions will be checked and upon owning the required permissions the HTTP-request will be issued.

Note: There is no real function as deleting a Group. The closest functionality is leaving it.

pub fn is_nsfw(&self) -> bool

Determines if the channel is NSFW.

pub fn id(&self) -> ChannelId

Retrieves the Id of the inner Group, GuildChannel, or PrivateChannel.

pub fn position(&self) -> Option<i64>

Retrieves the position of the inner GuildChannel or ChannelCategory.

If other channel types are used it will return None.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy 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<'de> Deserialize<'de> for Channel

fn deserialize<D: Deserializer<'de>>(
    deserializer: D
) -> StdResult<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Channel

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

Formats the channel into a "mentioned" string.

This will return a different format for each type of channel:

• Groups: the generated name retrievable via Group::name;
• PrivateChannels: the recipient's name;
• GuildChannels: a string mentioning the channel that users who can see the channel can click on.

impl<'a> From<&'a Channel> for ChannelId

fn from(channel: &Channel) -> ChannelId

Gets the Id of a Channel.

impl From<Channel> for ChannelId

fn from(channel: Channel) -> ChannelId

Gets the Id of a Channel.

impl FromStrAndCache for Channel

type Err = ChannelParseError

fn from_str(
    cache: impl AsRef<CacheRwLock>,
    s: &str
) -> StdResult<Self, Self::Err>

impl Mentionable for Channel

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 Channel

fn serialize<S>(&self, serializer: S) -> StdResult<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.