Struct IncomingMessage 

pub struct IncomingMessage {
    pub raw: Message,
    pub client: Option<Client>,
}

A new or edited message.

Fields

raw: Message

The underlying TL message object.

client: Option<Client>

An embedded client reference, populated for messages received via stream_updates() and returned from send/search/history APIs. When present, the clientless action methods (reply, respond, edit, delete, pin, unpin, react, …) can be called without passing a &Client argument.

Implementations

impl IncomingMessage

pub fn download_location(&self) -> Option<InputFileLocation>

Get the download location for the media in this message, if any.

impl IncomingMessage

pub fn from_raw(raw: Message) -> Self

pub fn with_client(self, client: Client) -> Self

Attach a Client so the clientless action methods work.

Returns self for chaining:

let msg = IncomingMessage::from_raw(raw).with_client(client);

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

The message text (or caption for media messages).

pub fn id(&self) -> i32

Unique message ID within the chat.

pub fn peer_id(&self) -> Option<&Peer>

The peer (chat) this message belongs to.

pub fn sender_id(&self) -> Option<&Peer>

The sender peer, if available (not set for anonymous channel posts).

pub fn outgoing(&self) -> bool

true if the message was sent by the logged-in account.

pub fn date(&self) -> i32

Unix timestamp when the message was sent.

pub fn edit_date(&self) -> Option<i32>

Unix timestamp of the last edit, if the message has been edited.

pub fn mentioned(&self) -> bool

true if the logged-in user was mentioned in this message.

pub fn silent(&self) -> bool

true if the message was sent silently (no notification).

pub fn post(&self) -> bool

true if this is a channel post (no sender).

pub fn pinned(&self) -> bool

true if this message is currently pinned.

pub fn forward_count(&self) -> Option<i32>

Number of times the message has been forwarded (channels only).

pub fn view_count(&self) -> Option<i32>

View count for channel posts.

pub fn reply_count(&self) -> Option<i32>

Reply count (number of replies in a thread).

pub fn reply_to_message_id(&self) -> Option<i32>

ID of the message this one is replying to.

pub async fn reply_to_message( &self, client: &Client, ) -> Result<Option<IncomingMessage>, Error>

Fetch the message that this one is replying to.

Returns None if this message is not a reply or if the peer is unknown. Unlike reply_to_message_id this actually performs an API call to retrieve the full message object.

pub fn date_utc(&self) -> Option<DateTime<Utc>>

The message’s send time as a chrono::DateTime<chrono::Utc>.

This is a typed wrapper around the raw date() Unix timestamp.

pub fn edit_date_utc(&self) -> Option<DateTime<Utc>>

The last edit time as a chrono::DateTime<chrono::Utc>, if edited.

pub fn media(&self) -> Option<&MessageMedia>

The media attached to this message, if any.

pub fn entities(&self) -> Option<&Vec<MessageEntity>>

Formatting entities (bold, italic, code, links, etc).

pub fn grouped_id(&self) -> Option<i64>

Group ID for album messages (multiple media in one).

pub fn from_scheduled(&self) -> bool

true if this message was sent from a scheduled one.

pub fn edit_hide(&self) -> bool

true if the edit date is hidden from recipients.

pub fn media_unread(&self) -> bool

true if the media in this message has not been read yet.

pub fn via_bot_id(&self) -> Option<i64>

ID of the bot that sent this message via inline mode, if any.

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

Signature of the post author in a channel, if set.

pub fn reaction_count(&self) -> i32

Number of reactions on this message, if any.

pub fn restriction_reason(&self) -> Option<&Vec<RestrictionReason>>

Restriction reasons (why this message is unavailable in some regions).

pub fn reply_markup(&self) -> Option<&ReplyMarkup>

Reply markup (inline keyboards, etc).

pub fn forward_header(&self) -> Option<&MessageFwdHeader>

Forward info header, if this message was forwarded.

pub fn noforwards(&self) -> bool

true if forwarding this message is restricted.

pub fn markdown_text(&self) -> Option<String>

Reconstruct Markdown from the message text and its formatting entities.

Returns plain text if there are no entities.

pub fn html_text(&self) -> Option<String>

Reconstruct HTML from the message text and its formatting entities.

Returns plain text if there are no entities.

pub fn action(&self) -> Option<&MessageAction>

Service message action (e.g. “user joined”, “call started”).
Returns None for regular text/media messages.

pub fn photo(&self) -> Option<Photo>

Extract a Photo from the message media, if present.

Shorthand for Photo::from_media(msg.media()?).

pub fn document(&self) -> Option<Document>

Extract a Document from the message media, if present.

Shorthand for Document::from_media(msg.media()?).

pub async fn reply( &self, text: impl Into<String>, ) -> Result<IncomingMessage, Error>

Reply to this message (clientless: requires an embedded client).

Returns the sent message so you can chain further operations on it.

pub async fn reply_with( &self, client: &Client, text: impl Into<String>, ) -> Result<IncomingMessage, Error>

Reply to this message with a plain string.

Returns the sent message so you can chain further operations on it.

pub async fn reply_ex( &self, msg: InputMessage, ) -> Result<IncomingMessage, Error>

Reply with a full InputMessage (clientless).

pub async fn reply_ex_with( &self, client: &Client, msg: InputMessage, ) -> Result<IncomingMessage, Error>

Reply with a full InputMessage.

pub async fn respond( &self, text: impl Into<String>, ) -> Result<IncomingMessage, Error>

Send to the same chat without quoting (clientless).

pub async fn respond_with( &self, client: &Client, text: impl Into<String>, ) -> Result<IncomingMessage, Error>

Send to the same chat without quoting.

pub async fn respond_ex( &self, msg: InputMessage, ) -> Result<IncomingMessage, Error>

Full [InputMessage] to the same chat without quoting (clientless).

pub async fn respond_ex_with( &self, client: &Client, msg: InputMessage, ) -> Result<IncomingMessage, Error>

Full [InputMessage] to the same chat without quoting.

pub async fn edit(&self, new_text: impl Into<String>) -> Result<(), Error>

Edit this message (clientless).

pub async fn edit_with( &self, client: &Client, new_text: impl Into<String>, ) -> Result<(), Error>

Edit this message.

pub async fn delete(&self) -> Result<(), Error>

Delete this message (clientless).

pub async fn delete_with(&self, client: &Client) -> Result<(), Error>

Delete this message.

pub async fn mark_as_read(&self) -> Result<(), Error>

Mark this message (and all before it) as read (clientless).

pub async fn mark_as_read_with(&self, client: &Client) -> Result<(), Error>

Mark this message (and all before it) as read.

pub async fn pin(&self) -> Result<(), Error>

Pin this message silently (clientless).

pub async fn pin_with(&self, client: &Client) -> Result<(), Error>

Pin this message silently.

pub async fn unpin(&self) -> Result<(), Error>

Unpin this message (clientless).

pub async fn unpin_with(&self, client: &Client) -> Result<(), Error>

Unpin this message.

pub async fn forward_to( &self, destination: impl Into<PeerRef>, ) -> Result<IncomingMessage, Error>

Forward this message to another chat (clientless).

Returns the forwarded message in the destination chat.

pub async fn forward_to_with( &self, client: &Client, destination: impl Into<PeerRef>, ) -> Result<IncomingMessage, Error>

Forward this message to another chat.

Returns the forwarded message in the destination chat.

pub async fn refetch(&mut self) -> Result<(), Error>

Re-fetch this message from Telegram (clientless).

Useful to get updated view/forward counts, reactions, edit state, etc. Updates self in place; returns an error if the message was deleted.

pub async fn refetch_with(&mut self, client: &Client) -> Result<(), Error>

Re-fetch this message from Telegram.

pub async fn download_media( &self, path: impl AsRef<Path>, ) -> Result<bool, Error>

Download attached media to path (clientless).

pub async fn download_media_with( &self, client: &Client, path: impl AsRef<Path>, ) -> Result<bool, Error>

Download attached media to path. Returns true if media was found.

pub async fn react( &self, reactions: impl Into<InputReactions>, ) -> Result<(), Error>

Send a reaction (clientless).

Example

use layer_client::reactions::InputReactions;
msg.react(InputReactions::emoticon("👍")).await?;

pub async fn react_with( &self, client: &Client, reactions: impl Into<InputReactions>, ) -> Result<(), Error>

Send a reaction.

pub async fn get_reply(&self) -> Result<Option<IncomingMessage>, Error>

Fetch the message this is a reply to (clientless).

pub async fn get_reply_with( &self, client: &Client, ) -> Result<Option<IncomingMessage>, Error>

Fetch the message this is a reply to.

pub fn sender_user_id(&self) -> Option<i64>

The sender’s bare user-ID, if this is a user message.

Returns None for anonymous channel posts.

pub fn sender_chat_id(&self) -> Option<i64>

The chat/channel-ID the sender belongs to (non-user senders).

pub async fn sender_user(&self) -> Result<Option<User>, Error>

Fetch the sender as a typed User (clientless, async).

Returns None if the sender is not a user, or if the user is not in the local peer cache. Performs a network call if needed.

Trait Implementations

impl Clone for IncomingMessage

fn clone(&self) -> IncomingMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncomingMessage

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

Formats the value using the given formatter.