Enum discord_flows::model::Channel

pub enum Channel {
    Guild(GuildChannel),
    Private(PrivateChannel),
    Category(ChannelCategory),
}

A container for any channel.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Guild(GuildChannel)

A text, voice, stage or directory channel within a Guild.

Private(PrivateChannel)

A private channel to another User. No other users may access the channel.

Category(ChannelCategory)

A category of GuildChannels

Implementations

impl Channel

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

Converts from Channel to Option<GuildChannel>.

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

Examples

Basic usage:

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

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

Converts from Channel to Option<PrivateChannel>.

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

Examples

Basic usage:

match channel.private() {
    Some(private) => {
        println!("It's a private channel with {}!", &private.recipient);
    },
    None => {
        println!("It's not a private channel!");
    },
}

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

Converts from Channel to Option<ChannelCategory>.

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

Examples

Basic usage:

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

pub fn id(&self) -> ChannelId

Retrieves the Id of the inner 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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Channel

fn deserialize<D>( deserializer: D ) -> Result<Channel, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Channel

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

Formats the channel into a “mentioned” string.

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

• PrivateChannels: the recipient’s name;
• GuildChannels: a string mentioning the channel that users who can see the channel can click on.

impl Serialize for Channel

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

Serialize this value into the given Serde serializer.