Struct serenity::builder::CreateMessage

pub struct CreateMessage<'a>(pub HashMap<&'static str, Value>, pub Option<Vec<ReactionType>>, pub Vec<AttachmentType<'a>>);

A builder to specify the contents of an http::send_message request, primarily meant for use through ChannelId::send_message.

There are two situations where different field requirements are present:

1. When sending an embed, no other field is required;
2. Otherwise, content is the only required field that is required to be set.

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.

Examples

Sending a message with a content of "test" and applying text-to-speech:

use serenity::model::id::ChannelId;

let channel_id = ChannelId(7);

let _ = channel_id.send_message(&http, |m| {
    m.content("test");
    m.tts(true);

    m.embed(|mut e| {
        e.title("This is an embed");
        e.description("With a description");

        e
    });

    m
});

Implementations

impl<'a> CreateMessage<'a>

pub fn content<D: ToString>(&mut self, content: D) -> &mut Self

Set the content of the message.

Note: Message contents must be under 2000 unicode code points.

pub fn embed<F>(&mut self, f: F) -> &mut Self where
    F: FnOnce(&mut CreateEmbed) -> &mut CreateEmbed, 

Set an embed for the message.

pub fn tts(&mut self, tts: bool) -> &mut Self

Set whether the message is text-to-speech.

Think carefully before setting this to true.

Defaults to false.

pub fn reactions<R: Into<ReactionType>, It: IntoIterator<Item = R>>(
    &mut self,
    reactions: It
) -> &mut Self

Adds a list of reactions to create after the message's sent.

pub fn add_file<T: Into<AttachmentType<'a>>>(&mut self, file: T) -> &mut Self

Appends a file to the message.

pub fn add_files<T: Into<AttachmentType<'a>>, It: IntoIterator<Item = T>>(
    &mut self,
    files: It
) -> &mut Self

Appends a list of files to the message.

pub fn files<T: Into<AttachmentType<'a>>, It: IntoIterator<Item = T>>(
    &mut self,
    files: It
) -> &mut Self

Sets a list of files to include in the message.

Calling this multiple times will overwrite the file list. To append files, call add_file or add_files instead.

Trait Implementations

impl<'a> Clone for CreateMessage<'a>

pub fn clone(&self) -> CreateMessage<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CreateMessage<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CreateMessage<'a>

pub fn default() -> CreateMessage<'a>

Creates a map for sending a Message, setting tts to false by default.