Enum Channel 

pub enum Channel {
    SavedMessages {
        id: String,
        user: String,
    },
    DirectMessage {
        id: String,
        active: bool,
        recipients: Vec<String>,
        last_message_id: Option<String>,
    },
    Group {
        id: String,
        name: String,
        owner: String,
        description: Option<String>,
        recipients: Vec<String>,
        icon: Option<File>,
        last_message_id: Option<String>,
        permissions: Option<i64>,
        nsfw: bool,
    },
    TextChannel {
        id: String,
        server: String,
        name: String,
        description: Option<String>,
        icon: Option<File>,
        last_message_id: Option<String>,
        default_permissions: Option<OverrideField>,
        role_permissions: HashMap<String, OverrideField>,
        nsfw: bool,
    },
    VoiceChannel {
        id: String,
        server: String,
        name: String,
        description: Option<String>,
        icon: Option<File>,
        default_permissions: Option<OverrideField>,
        role_permissions: HashMap<String, OverrideField>,
        nsfw: bool,
    },
}

Channel

Variants

SavedMessages

Personal “Saved Notes” channel which allows users to save messages

Fields

id: String

Unique Id

user: String

Id of the user this channel belongs to

DirectMessage

Direct message channel between two users

Fields

id: String

Unique Id

active: bool

Whether this direct message channel is currently open on both sides

recipients: Vec<String>

2-tuple of user ids participating in direct message

last_message_id: Option<String>

Id of the last message sent in this channel

Group

Group channel between 1 or more participants

Fields

id: String

Unique Id

name: String

Display name of the channel

owner: String

User id of the owner of the group

description: Option<String>

Channel description

recipients: Vec<String>

Array of user ids participating in channel

icon: Option<File>

Custom icon attachment

last_message_id: Option<String>

Id of the last message sent in this channel

permissions: Option<i64>

Permissions assigned to members of this group (does not apply to the owner of the group)

nsfw: bool

Whether this group is marked as not safe for work

TextChannel

Text channel belonging to a server

Fields

id: String

Unique Id

server: String

Id of the server this channel belongs to

name: String

Display name of the channel

description: Option<String>

Channel description

icon: Option<File>

Custom icon attachment

last_message_id: Option<String>

Id of the last message sent in this channel

default_permissions: Option<OverrideField>

Default permissions assigned to users in this channel

role_permissions: HashMap<String, OverrideField>

Permissions assigned based on role to this channel

nsfw: bool

Whether this channel is marked as not safe for work

VoiceChannel

Voice channel belonging to a server

Fields

id: String

Unique Id

server: String

Id of the server this channel belongs to

name: String

Display name of the channel

description: Option<String>

Channel description

icon: Option<File>

Custom icon attachment

default_permissions: Option<OverrideField>

Default permissions assigned to users in this channel

role_permissions: HashMap<String, OverrideField>

Permissions assigned based on role to this channel

nsfw: bool

Whether this channel is marked as not safe for work

Implementations

impl Channel

pub fn id(&self) -> &str

Get a reference to this channel’s id

pub fn name(&self) -> Option<&str>

This returns a Result because the recipient name can’t be determined here without a db call, which can’t be done since this is models, which can’t reference the database crate.

If it returns None, you need to fetch the name from the db.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a duplicate 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: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Channel

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Channel

fn eq(&self, other: &Channel) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Channel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for Channel

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl Eq for Channel

impl StructuralPartialEq for Channel