Struct twilight_http::request::channel::message::create_message::CreateMessage[−][src]

pub struct CreateMessage<'a> { /* fields omitted */ }

Expand description

Send a message to a channel.

Example

use twilight_http::Client;
use twilight_model::id::ChannelId;

let client = Client::new("my token");

let channel_id = ChannelId(123);
let message = client
    .create_message(channel_id)
    .content("Twilight is best pony")?
    .tts(true)
    .await?;

Implementations

[src]

impl<'a> CreateMessage<'a>

[src]

pub fn allowed_mentions(self, allowed_mentions: AllowedMentions) -> Self

Specify the AllowedMentions for the message.

[src]

pub fn content(
    self, 
    content: impl Into<String>
) -> Result<Self, CreateMessageError>

Set the content of the message.

The maximum length is 2000 UTF-16 characters.

Errors

Returns a CreateMessageErrorType::ContentInvalid error type if the content length is too long.

[src]

pub fn embed(self, embed: Embed) -> Result<Self, CreateMessageError>

👎 Deprecated since 0.5.5:

will be removed in favor of embeds

Attach an embed to the message.

Embed total character length must not exceed 6000 characters. Additionally, the internal fields also have character limits. Refer to the discord docs for more information.

Examples

See EmbedBuilder for an example.

Errors

Returns a CreateMessageErrorType::EmbedTooLarge error type if the embed is too large.

[src]

pub fn embeds(
    self, 
    embeds: impl IntoIterator<Item = Embed>
) -> Result<Self, CreateMessageError>

Attach multiple embeds to the message.

Embed total character length must not exceed 6000 characters. Additionally, the internal fields also have character limits. Refer to the discord docs for more information.

Errors

Returns a CreateMessageErrorType::EmbedTooLarge error type if an embed is too large.

[src]

pub fn fail_if_not_exists(self) -> Self

Whether to fail sending if the reply no longer exists.

[src]

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

👎 Deprecated since 0.5.5:

will be removed in favor of files

Attach a file to the message.

The file is raw binary data. It can be an image, or any other kind of file.

[src]

pub fn files<N: Into<String>, F: Into<Vec<u8>>>(
    self, 
    files: impl IntoIterator<Item = (N, F)>
) -> Self

Attach multiple files to the message.

[src]

pub fn nonce(self, nonce: u64) -> Self

Attach a nonce to the message, for optimistic message sending.

[src]

pub fn payload_json(self, payload_json: impl Into<Vec<u8>>) -> Self

JSON encoded body of any additional request fields.

If this method is called, all other fields are ignored, except for file. See Discord Docs/Create Message.

[src]

pub fn reply(self, other: MessageId) -> Self

Specify the ID of another message to create a reply to.

[src]

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

Specify true if the message is TTS.

Trait Implementations

[src]

impl Future for CreateMessage<'_>

type Output = Result<Message, Error>

The type of value produced on completion.

[src]

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations

impl<'a> !RefUnwindSafe for CreateMessage<'a>

impl<'a> Send for CreateMessage<'a>

impl<'a> !Sync for CreateMessage<'a>

impl<'a> Unpin for CreateMessage<'a>

impl<'a> !UnwindSafe for CreateMessage<'a>

Blanket Implementations

[src]

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

impl<T> FutureExt for T where
    T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Output) -> U,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn map_into<U>(self) -> MapInto<Self, U> where
    Self::Output: Into<U>,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnOnce(Self::Output) -> Fut,
    Fut: Future,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

fn left_future<B>(self) -> Either<Self, B> where
    B: Future<Output = Self::Output>,

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

fn right_future<A>(self) -> Either<A, Self> where
    A: Future<Output = Self::Output>,

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Output: Future,

Flatten the execution of this future when the output of this future is itself another future. Read more

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Output: Stream,

Flatten the execution of this future when the successful result of this future is a stream. Read more

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Output),

Do something with the output of a future before passing it on. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe,

Catches unwinding panics while polling the future. Read more

fn shared(self) -> Shared<Self> where
    Self::Output: Clone,

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

fn boxed<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
    Self: Send + 'a,

Wrap the future in a Box, pinning it. Read more

fn boxed_local<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
    Self: 'a,

Wrap the future in a Box, pinning it. Read more

fn unit_error(self) -> UnitError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>. Read more

fn never_error(self) -> NeverError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>. Read more

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
    Self: Unpin,

A convenience for calling Future::poll on Unpin future types.

fn now_or_never(self) -> Option<Self::Output>

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<F> IntoFuture for F where
    F: Future,

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

[src]

pub fn into_future(self) -> <F as IntoFuture>::Future

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<F, T, E> TryFuture for F where
    F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

pub fn try_poll(
    self: Pin<&mut F>, 
    cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more

impl<Fut> TryFutureExt for Fut where
    Fut: TryFuture + ?Sized,

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
    F: FnOnce(Self::Ok) -> T,

Maps this future’s success value to a different value. Read more

fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
    E: FnOnce(Self::Error) -> T,
    F: FnOnce(Self::Ok) -> T,

Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more

fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E,

Maps this future’s error value to a different value. Read more

fn err_into<E>(self) -> ErrInto<Self, E> where
    Self::Error: Into<E>,

Maps this future’s Error to a new error type using the Into trait. Read more

fn ok_into<U>(self) -> OkInto<Self, U> where
    Self::Ok: Into<U>,

Maps this future’s Ok to a new type using the Into trait. Read more

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
    F: FnOnce(Self::Ok) -> Fut,
    Fut: TryFuture<Error = Self::Error>,

Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
    F: FnOnce(Self::Error) -> Fut,
    Fut: TryFuture<Ok = Self::Ok>,

Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
    F: FnOnce(&Self::Ok),

Do something with the success value of a future before passing it on. Read more

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnOnce(&Self::Error),

Do something with the error value of a future before passing it on. Read more

fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
    Self::Ok: TryFuture,
    <Self::Ok as TryFuture>::Error == Self::Error,

Flatten the execution of this future when the successful result of this future is another future. Read more

fn try_flatten_stream(self) -> TryFlattenStream<Self> where
    Self::Ok: TryStream,
    <Self::Ok as TryStream>::Error == Self::Error,

Flatten the execution of this future when the successful result of this future is a stream. Read more

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
    F: FnOnce(Self::Error) -> Self::Ok,

Unwraps this future’s output, producing a future with this future’s Ok type as its Output type. Read more

fn into_future(self) -> IntoFuture<Self>

Wraps a [TryFuture] into a type that implements Future. Read more

fn try_poll_unpin(
    &mut self, 
    cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
    Self: Unpin,

A convenience method for calling [TryFuture::try_poll] on Unpin future types. Read more

[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V