Split GuildThread from GuildChannel

Author: GnomedDev

Cargo.toml

@@ -39,6 +39,7 @@ to-arraystring = "0.2.0"
 extract_map = { version = "0.1.0", features = ["serde", "iter_mut"] }
 aformat = "0.1.3"
 bytes = "1.5.0"
+ref-cast = "1.0.23"
 # Optional dependencies
 fxhash = { version = "0.2.1", optional = true }
 chrono = { version = "0.4.31", default-features = false, features = ["clock", "serde"], optional = true }

examples/e12_parallel_loops/src/main.rs

@@ -8,7 +8,7 @@ use serenity::builder::{CreateEmbed, CreateMessage};
 use serenity::gateway::ActivityData;
 use serenity::model::channel::Message;
 use serenity::model::gateway::Ready;
-use serenity::model::id::{ChannelId, GuildId};
+use serenity::model::id::{GenericChannelId, GuildId};
 use serenity::prelude::*;
 
 struct Handler {
@@ -85,7 +85,7 @@ async fn log_system_load(ctx: &Context) {
             false,
         );
     let builder = CreateMessage::new().embed(embed);
-    let message = ChannelId::new(381926291785383946).send_message(&ctx.http, builder).await;
+    let message = GenericChannelId::new(381926291785383946).send_message(&ctx.http, builder).await;
     if let Err(why) = message {
         eprintln!("Error sending message: {why:?}");
     };

examples/testing/src/main.rs

@@ -85,7 +85,8 @@ async fn message(ctx: &Context, msg: Message) -> Result<(), serenity::Error> {
         model_type_sizes::print_ranking();
     } else if msg.content == "auditlog" {
         // Test special characters in audit log reason
-        msg.channel_id
+        channel_id
+            .expect_channel()
             .edit(
                 &ctx.http,
                 EditChannel::new().name("new-channel-name").audit_log_reason("hello\nworld\n🙂"),
@@ -153,6 +154,7 @@ async fn message(ctx: &Context, msg: Message) -> Result<(), serenity::Error> {
         guild_id.ban(&ctx.http, user_id, 0, None).await?;
     } else if msg.content == "createtags" {
         channel_id
+            .expect_channel()
             .edit(
                 &ctx.http,
                 EditChannel::new().available_tags(vec![
@@ -163,9 +165,10 @@ async fn message(ctx: &Context, msg: Message) -> Result<(), serenity::Error> {
             .await?;
     } else if msg.content == "assigntags" {
         let forum_id = msg.guild_channel(&ctx).await?.parent_id.unwrap();
-        let forum = forum_id.to_guild_channel(&ctx, msg.guild_id).await?;
+        let forum = forum_id.widen().to_guild_channel(&ctx, msg.guild_id).await?;
         channel_id
-            .edit_thread(
+            .expect_thread()
+            .edit(
                 &ctx.http,
                 EditThread::new()
                     .applied_tags(forum.available_tags.iter().map(|t| t.id).collect::<Vec<_>>()),
@@ -197,7 +200,7 @@ async fn message(ctx: &Context, msg: Message) -> Result<(), serenity::Error> {
         msg.author.id.dm(&ctx.http, builder).await?;
     } else if let Some(channel) = msg.content.strip_prefix("movetorootandback") {
         let mut channel = {
-            let channel_id = channel.trim().parse::<ChannelId>().unwrap();
+            let channel_id = channel.trim().parse::<GenericChannelId>().unwrap();
             channel_id.to_guild_channel(&ctx, msg.guild_id).await.unwrap()
         };
 

examples/testing/src/model_type_sizes.rs

@@ -65,6 +65,7 @@ pub fn print_ranking() {
         ("GuildBanAddEvent", std::mem::size_of::<GuildBanAddEvent>()),
         ("GuildBanRemoveEvent", std::mem::size_of::<GuildBanRemoveEvent>()),
         ("GuildChannel", std::mem::size_of::<GuildChannel>()),
+        ("GuildThread", std::mem::size_of::<GuildThread>()),
         ("GuildCreateEvent", std::mem::size_of::<GuildCreateEvent>()),
         ("GuildDeleteEvent", std::mem::size_of::<GuildDeleteEvent>()),
         ("GuildEmojisUpdateEvent", std::mem::size_of::<GuildEmojisUpdateEvent>()),
@@ -131,10 +132,12 @@ pub fn print_ranking() {
         ("ModalInteraction", std::mem::size_of::<ModalInteraction>()),
         ("ModalInteractionData", std::mem::size_of::<ModalInteractionData>()),
         ("AuditLogEntryOptions", std::mem::size_of::<AuditLogEntryOptions>()),
-        ("PartialChannel", std::mem::size_of::<PartialChannel>()),
+        ("GenericInteractionChannel", std::mem::size_of::<GenericInteractionChannel>()),
+        ("InteractionChannel", std::mem::size_of::<InteractionChannel>()),
+        ("InteractionGuildThread", std::mem::size_of::<InteractionGuildThread>()),
         ("PartialCurrentApplicationInfo", std::mem::size_of::<PartialCurrentApplicationInfo>()),
         ("PartialGuild", std::mem::size_of::<PartialGuild>()),
-        ("PartialGuildChannel", std::mem::size_of::<PartialGuildChannel>()),
+        ("PartialGuildThread", std::mem::size_of::<PartialGuildThread>()),
         ("PartialMember", std::mem::size_of::<PartialMember>()),
         ("PermissionOverwrite", std::mem::size_of::<PermissionOverwrite>()),
         ("Permissions", std::mem::size_of::<Permissions>()),

src/builder/create_allowed_mentions.rs

@@ -28,8 +28,7 @@ impl ParseAction {
     }
 }
 
-/// A builder to manage the allowed mentions on a message, used by the [`ChannelId::send_message`]
-/// and [`ChannelId::edit_message`] methods.
+/// A builder to manage the allowed mentions on a message.
 ///
 /// # Examples
 ///

src/builder/create_components.rs

@@ -224,7 +224,7 @@ pub enum CreateSelectMenuKind<'a> {
     },
     Channel {
         channel_types: Option<Cow<'a, [ChannelType]>>,
-        default_channels: Option<Cow<'a, [ChannelId]>>,
+        default_channels: Option<Cow<'a, [GenericChannelId]>>,
     },
 }
 

src/builder/create_embed.rs

@@ -185,12 +185,11 @@ impl<'a> CreateEmbed<'a> {
 
     /// Same as calling [`Self::image`] with "attachment://filename.(jpg, png)".
     ///
-    /// Note however, you have to be sure you set an attachment (with [`ChannelId::send_files`])
-    /// with the provided filename. Or else this won't work.
+    /// Remember to set an attachment with the provided filename via [`CreateAttachment`]
     ///
     /// Refer [`Self::image`] for rules on naming local attachments.
     ///
-    /// [`ChannelId::send_files`]: crate::model::id::ChannelId::send_files
+    /// [`CreateAttachment`]: crate::builder::CreateAttachment
     pub fn attachment(self, filename: impl Into<String>) -> Self {
         let mut filename = filename.into();
         filename.insert_str(0, "attachment://");

src/builder/create_message.rs

@@ -16,7 +16,7 @@ use crate::internal::prelude::*;
 use crate::model::prelude::*;
 
 /// A builder to specify the contents of an send message request, primarily meant for use
-/// through [`ChannelId::send_message`].
+/// through [`GenericChannelId::send_message`].
 ///
 /// There are three situations where different field requirements are present:
 ///
@@ -27,21 +27,21 @@ use crate::model::prelude::*;
 ///    required.
 ///
 /// Note that if you only need to send the content of a message, without specifying other fields,
-/// then [`ChannelId::say`] may be a more preferable option.
+/// then [`GenericChannelId::say`] may be a more preferable option.
 ///
 /// # Examples
 ///
 /// Sending a message with a content of `"test"` and applying text-to-speech:
 ///
 /// ```rust,no_run
 /// use serenity::builder::{CreateEmbed, CreateMessage};
-/// use serenity::model::id::ChannelId;
+/// use serenity::model::id::GenericChannelId;
 /// # use serenity::http::Http;
 /// # use std::sync::Arc;
 /// #
 /// # async fn run() {
 /// # let http: Arc<Http> = unimplemented!();
-/// # let channel_id = ChannelId::new(7);
+/// # let channel_id = GenericChannelId::new(7);
 /// let embed = CreateEmbed::new().title("This is an embed").description("With a description");
 /// let builder = CreateMessage::new().content("test").tts(true).embed(embed);
 /// let _ = channel_id.send_message(&http, builder).await;
@@ -290,7 +290,7 @@ impl<'a> CreateMessage<'a> {
     pub async fn execute(
         mut self,
         http: &Http,
-        channel_id: ChannelId,
+        channel_id: GenericChannelId,
         guild_id: Option<GuildId>,
     ) -> Result<Message> {
         self.check_length()?;

src/builder/create_scheduled_event.rs

@@ -131,8 +131,8 @@ impl<'a> CreateScheduledEvent<'a> {
     ///
     /// [Create Events]: Permissions::CREATE_EVENTS
     #[cfg(feature = "http")]
-    pub async fn execute(self, http: &Http, channel_id: GuildId) -> Result<ScheduledEvent> {
-        http.create_scheduled_event(channel_id, &self, self.audit_log_reason).await
+    pub async fn execute(self, http: &Http, guild_id: GuildId) -> Result<ScheduledEvent> {
+        http.create_scheduled_event(guild_id, &self, self.audit_log_reason).await
     }
 }
 

src/builder/edit_channel.rs

@@ -331,6 +331,9 @@ impl<'a> EditChannel<'a> {
             .await?;
         }
 
-        http.edit_channel(channel_id, &self, self.audit_log_reason).await
+        http.edit_channel(channel_id.widen(), &self, self.audit_log_reason)
+            .await?
+            .guild()
+            .ok_or(Error::Model(ModelError::InvalidChannelType))
     }
 }

src/builder/edit_guild_welcome_screen.rs

@@ -82,14 +82,14 @@ impl<'a> EditGuildWelcomeScreen<'a> {
 #[derive(Clone, Debug, Serialize)]
 #[must_use]
 pub struct CreateGuildWelcomeChannel<'a> {
-    channel_id: ChannelId,
+    channel_id: GenericChannelId,
     emoji_name: Option<String>,
     emoji_id: Option<EmojiId>,
     description: Cow<'a, str>,
 }
 
 impl<'a> CreateGuildWelcomeChannel<'a> {
-    pub fn new(channel_id: ChannelId, description: impl Into<Cow<'a, str>>) -> Self {
+    pub fn new(channel_id: GenericChannelId, description: impl Into<Cow<'a, str>>) -> Self {
         Self {
             channel_id,
             emoji_id: None,
@@ -99,7 +99,7 @@ impl<'a> CreateGuildWelcomeChannel<'a> {
     }
 
     /// The Id of the channel to show.
-    pub fn id(mut self, id: ChannelId) -> Self {
+    pub fn id(mut self, id: GenericChannelId) -> Self {
         self.channel_id = id;
         self
     }

src/builder/edit_message.rs

@@ -115,7 +115,7 @@ impl<'a> EditMessage<'a> {
     /// ```rust,no_run
     /// # use serenity::all::*;
     /// # #[cfg(feature = "collector")]
-    /// # async fn test(ctx: &Context, channel_id: ChannelId) -> Result<(), Error> {
+    /// # async fn test(ctx: &Context, channel_id: GenericChannelId) -> Result<(), Error> {
     /// use std::time::Duration;
     ///
     /// use futures::StreamExt;
@@ -239,7 +239,7 @@ impl<'a> EditMessage<'a> {
     pub async fn execute(
         mut self,
         cache_http: impl CacheHttp,
-        channel_id: ChannelId,
+        channel_id: GenericChannelId,
         message_id: MessageId,
         user_id: Option<UserId>,
     ) -> Result<Message> {

src/builder/edit_thread.rs

@@ -108,8 +108,12 @@ impl<'a> EditThread<'a> {
     /// # Errors
     ///
     /// Returns [`Error::Http`] if the current user lacks permission.
+    /// Returns [`ModelError::InvalidChannelType`] if the `ThreadId` is not identifying a thread.
     #[cfg(feature = "http")]
-    pub async fn execute(self, http: &Http, channel_id: ChannelId) -> Result<GuildChannel> {
-        http.edit_thread(channel_id, &self, self.audit_log_reason).await
+    pub async fn execute(self, http: &Http, thread_id: ThreadId) -> Result<GuildThread> {
+        http.edit_channel(thread_id.widen(), &self, self.audit_log_reason)
+            .await?
+            .thread()
+            .ok_or(Error::Model(ModelError::InvalidChannelType))
     }
 }

src/builder/edit_webhook_message.rs

@@ -31,7 +31,7 @@ pub struct EditWebhookMessage<'a> {
     pub(crate) attachments: Option<EditAttachments<'a>>,
 
     #[serde(skip)]
-    thread_id: Option<ChannelId>,
+    thread_id: Option<ThreadId>,
 }
 
 impl<'a> EditWebhookMessage<'a> {
@@ -55,7 +55,7 @@ impl<'a> EditWebhookMessage<'a> {
 
     /// Edits a message within a given thread. If the provided thread Id doesn't belong to the
     /// current webhook, the API will return an error.
-    pub fn in_thread(mut self, thread_id: ChannelId) -> Self {
+    pub fn in_thread(mut self, thread_id: ThreadId) -> Self {
         self.thread_id = Some(thread_id);
         self
     }

src/builder/execute_webhook.rs

@@ -76,7 +76,7 @@ pub struct ExecuteWebhook<'a> {
     attachments: EditAttachments<'a>,
 
     #[serde(skip)]
-    thread_id: Option<ChannelId>,
+    thread_id: Option<ThreadId>,
 }
 
 impl<'a> ExecuteWebhook<'a> {
@@ -159,19 +159,19 @@ impl<'a> ExecuteWebhook<'a> {
     /// ```rust,no_run
     /// # use serenity::builder::ExecuteWebhook;
     /// # use serenity::http::Http;
-    /// # use serenity::model::{id::ChannelId, webhook::Webhook};
+    /// # use serenity::model::{id::ThreadId, webhook::Webhook};
     /// #
     /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
     /// # let http: Http = unimplemented!();
     /// let url = "https://discord.com/api/webhooks/245037420704169985/ig5AO-wdVWpCBtUUMxmgsWryqgsW3DChbKYOINftJ4DCrUbnkedoYZD0VOH1QLr-S3sV";
     /// let mut webhook = Webhook::from_url(&http, url).await?;
     ///
-    /// let builder = ExecuteWebhook::new().in_thread(ChannelId::new(12345678)).content("test");
+    /// let builder = ExecuteWebhook::new().in_thread(ThreadId::new(12345678)).content("test");
     /// webhook.execute(&http, false, builder).await?;
     /// # Ok(())
     /// # }
     /// ```
-    pub fn in_thread(mut self, thread_id: ChannelId) -> Self {
+    pub fn in_thread(mut self, thread_id: ThreadId) -> Self {
         self.thread_id = Some(thread_id);
         self
     }

src/builder/get_messages.rs

@@ -21,7 +21,7 @@ use crate::model::prelude::*;
 /// The other parameter specifies the number of messages to retrieve. This is _optional_, and
 /// defaults to 50 if not specified.
 ///
-/// See [`ChannelId::messages`] for more examples.
+/// See [`GenericChannelId::messages`] for more examples.
 ///
 /// # Examples
 ///
@@ -34,10 +34,10 @@ use crate::model::prelude::*;
 /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
 /// # let http: Http = unimplemented!();
 /// use serenity::builder::GetMessages;
-/// use serenity::model::id::{ChannelId, MessageId};
+/// use serenity::model::id::{GenericChannelId, MessageId};
 ///
 /// // you can then pass it into a function which retrieves messages:
-/// let channel_id = ChannelId::new(81384788765712384);
+/// let channel_id = GenericChannelId::new(81384788765712384);
 ///
 /// let builder = GetMessages::new().after(MessageId::new(158339864557912064)).limit(25);
 /// let _messages = channel_id.messages(&http, builder).await?;
@@ -106,7 +106,7 @@ impl GetMessages {
     pub async fn execute(
         self,
         cache_http: impl CacheHttp,
-        channel_id: ChannelId,
+        channel_id: GenericChannelId,
     ) -> Result<Vec<Message>> {
         let http = cache_http.http();
         let search_filter = self.search_filter.map(Into::into);