Struct Response 

pub struct Response { /* private fields */ }

Unified bot response builder

Represents a response that can be sent back to any platform. Each platform adapter converts this to platform-specific format.

The builder methods (with_embed, ephemeral, with_caption, …) apply to whichever kind of response they make sense for. Calling a message builder on an empty response promotes it to a message rather than silently dropping the value, so Response::empty().with_embed(e) sends the embed.

Implementations

impl Response

pub fn empty() -> Self

Create an empty response (no reply)

pub fn text(content: impl Into<String>) -> Self

Create a text response

pub fn acknowledge() -> Self

Create an acknowledgement response (deferred)

pub fn embed(embed: Embed) -> Self

Create a response with an embed

pub fn file(file: File) -> Self

Create a file response from an open file handle

pub fn bytes(bytes: impl Into<Vec<u8>>) -> Self

Create a file response from bytes already in memory

pub fn path(path: impl Into<PathBuf>) -> Self

Create a file response that reads path when the response is sent

The filename defaults to the path’s final component.

pub fn with_embed(self, embed: Embed) -> Self

Add an embed to this response

pub fn with_components(self, components: Vec<Component>) -> Self

Add components (buttons, select menus) to this response

pub fn ephemeral(self) -> Self

Make this response ephemeral (only visible to the user)

Platforms without ephemeral messages (Telegram, Matrix) ignore this.

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

Set the filename for a file response

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

Set the caption for a file response

pub fn is_empty(&self) -> bool

Check if this response carries nothing to send

pub fn is_acknowledge(&self) -> bool

Check if this is an acknowledge response

pub fn content(&self) -> Option<&str>

Get response content if this is a message response

pub fn embeds(&self) -> &[Embed]

Get embeds if this is a message response

pub fn components(&self) -> &[Component]

Get components if this is a message response

pub fn is_ephemeral(&self) -> bool

Check if this response is ephemeral

pub fn is_file(&self) -> bool

Check if this is a file response

pub fn take_file(&mut self) -> Option<FileResponse>

Take the file response data, leaving an empty response in its place

This consumes the file data, so it can only be called once.

Trait Implementations

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

impl IntoResponse for Response

fn into_response(self) -> Response

Convert this type into a bot response