twilight_http/request/channel/thread/
create_thread_from_message.rs

1use crate::{
2    client::Client,
3    error::Error,
4    request::{Request, TryIntoRequest},
5    response::{Response, ResponseFuture},
6    routing::Route,
7};
8use serde::Serialize;
9use std::future::IntoFuture;
10use twilight_model::{
11    channel::{thread::AutoArchiveDuration, Channel},
12    id::{
13        marker::{ChannelMarker, MessageMarker},
14        Id,
15    },
16};
17use twilight_validate::channel::{name as validate_name, ChannelValidationError};
18
19#[derive(Serialize)]
20struct CreateThreadFromMessageFields<'a> {
21    #[serde(skip_serializing_if = "Option::is_none")]
22    auto_archive_duration: Option<AutoArchiveDuration>,
23    name: &'a str,
24}
25
26/// Create a new thread from an existing message.
27///
28/// When called on a [`GuildText`] channel, this creates a
29/// [`PublicThread`].
30///
31/// When called on a [`GuildAnnouncement`] channel, this creates a [`AnnouncementThread`].
32///
33/// This request does not work when called on a [`GuildForum`] channel.
34///
35/// Automatic archive durations are not locked behind the guild's boost level.
36///
37/// The thread's ID will be the same as its parent message. This ensures only
38/// one thread can be created per message.
39///
40/// [`AnnouncementThread`]: twilight_model::channel::ChannelType::AnnouncementThread
41/// [`GuildAnnouncement`]: twilight_model::channel::ChannelType::GuildAnnouncement
42/// [`GuildForum`]: twilight_model::channel::ChannelType::GuildForum
43/// [`GuildPublicThread`]: twilight_model::channel::ChannelType::GuildPublicThread
44/// [`GuildText`]: twilight_model::channel::ChannelType::GuildText
45/// [`PublicThread`]: twilight_model::channel::ChannelType::PublicThread
46#[must_use = "requests must be configured and executed"]
47pub struct CreateThreadFromMessage<'a> {
48    channel_id: Id<ChannelMarker>,
49    fields: Result<CreateThreadFromMessageFields<'a>, ChannelValidationError>,
50    http: &'a Client,
51    message_id: Id<MessageMarker>,
52}
53
54impl<'a> CreateThreadFromMessage<'a> {
55    pub(crate) fn new(
56        http: &'a Client,
57        channel_id: Id<ChannelMarker>,
58        message_id: Id<MessageMarker>,
59        name: &'a str,
60    ) -> Self {
61        let fields = Ok(CreateThreadFromMessageFields {
62            auto_archive_duration: None,
63            name,
64        })
65        .and_then(|fields| {
66            validate_name(name)?;
67
68            Ok(fields)
69        });
70
71        Self {
72            channel_id,
73            fields,
74            http,
75            message_id,
76        }
77    }
78
79    /// Set the thread's auto archive duration.
80    ///
81    /// Automatic archive durations are not locked behind the guild's boost
82    /// level.
83    pub fn auto_archive_duration(mut self, auto_archive_duration: AutoArchiveDuration) -> Self {
84        if let Ok(fields) = self.fields.as_mut() {
85            fields.auto_archive_duration = Some(auto_archive_duration);
86        }
87
88        self
89    }
90}
91
92impl IntoFuture for CreateThreadFromMessage<'_> {
93    type Output = Result<Response<Channel>, Error>;
94
95    type IntoFuture = ResponseFuture<Channel>;
96
97    fn into_future(self) -> Self::IntoFuture {
98        let http = self.http;
99
100        match self.try_into_request() {
101            Ok(request) => http.request(request),
102            Err(source) => ResponseFuture::error(source),
103        }
104    }
105}
106
107impl TryIntoRequest for CreateThreadFromMessage<'_> {
108    fn try_into_request(self) -> Result<Request, Error> {
109        let fields = self.fields.map_err(Error::validation)?;
110
111        Request::builder(&Route::CreateThreadFromMessage {
112            channel_id: self.channel_id.get(),
113            message_id: self.message_id.get(),
114        })
115        .json(&fields)
116        .build()
117    }
118}