Struct CreateThread

pub struct CreateThread<'a> { /* private fields */ }

Discord docs:

• starting thread from message
• starting thread without message

Implementations

impl<'a> CreateThread<'a>

pub fn new(name: impl Into<String>) -> Self

Creates a builder with the given thread name, leaving all other fields empty.

pub fn name(self, name: impl Into<String>) -> Self

The name of the thread. Replaces the current value as set in Self::new.

Note: Must be between 2 and 100 characters long.

pub fn auto_archive_duration(self, duration: AutoArchiveDuration) -> Self

Duration in minutes to automatically archive the thread after recent activity.

pub fn rate_limit_per_user(self, seconds: u16) -> Self

How many seconds must a user wait before sending another message.

Bots, or users with the MANAGE_MESSAGES and/or MANAGE_CHANNELS permissions are exempt from this restriction.

Note: Must be between 0 and 21600 seconds (360 minutes or 6 hours).

pub fn invitable(self, invitable: bool) -> Self

Whether or not non-moderators can add other non-moderators to a thread.

pub fn kind(self, kind: ChannelType) -> Self

The thread type, either ChannelType::PublicThread or ChannelType::PrivateThread.

Note: This field is ignored for message threads, and defaults to ChannelType::PrivateThread for standalone threads in order to match the behavior when thread documentation was first published. This is a bit of a weird default though, and thus is highly likely to change in the future, so it is recommended to always explicitly setting it to avoid any breaking change.

pub fn audit_log_reason(self, reason: &'a str) -> Self

Sets the request’s audit log reason.

Trait Implementations

impl Builder for CreateThread<'_>

fn execute<'life0, 'async_trait>( self, cache_http: impl 'async_trait + CacheHttp, ctx: Self::Context<'life0>, ) -> Pin<Box<dyn Future<Output = Result<GuildChannel>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a thread, either private or public. Public threads require a message to connect the thread to.

Errors

Returns Error::Http if the current user lacks permission, or if invalid data is given.

type Context<'ctx> = (ChannelId, Option<MessageId>)

Additional data that’s only required when sending a request off to the API.

type Built = GuildChannel

impl<'a> Clone for CreateThread<'a>

fn clone(&self) -> CreateThread<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for CreateThread<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for CreateThread<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.