Struct MessageEntity

pub struct MessageEntity {
    pub kind: MessageEntityKind,
    pub offset: usize,
    pub length: usize,
}

This object represents one special entity in a text message.

For example, hashtags, usernames, URLs, etc.

The official docs.

Fields

kind: MessageEntityKind

offset: usize

Offset in UTF-16 code units to the start of the entity.

length: usize

Length of the entity in UTF-16 code units.

Implementations

impl MessageEntity

pub const fn new(kind: MessageEntityKind, offset: usize, length: usize) -> Self

pub const fn bold(offset: usize, length: usize) -> Self

Create a message entity representing a bold text.

pub const fn italic(offset: usize, length: usize) -> Self

Create a message entity representing an italic text.

pub const fn underline(offset: usize, length: usize) -> Self

Create a message entity representing an underline text.

pub const fn strikethrough(offset: usize, length: usize) -> Self

Create a message entity representing a strikethrough text.

pub const fn spoiler(offset: usize, length: usize) -> Self

Create a message entity representing a spoiler text.

pub const fn code(offset: usize, length: usize) -> Self

Create a message entity representing a monowidth text.

pub const fn pre(language: Option<String>, offset: usize, length: usize) -> Self

Create a message entity representing a monowidth block.

pub const fn text_link(url: Url, offset: usize, length: usize) -> Self

Create a message entity representing a clickable text URL.

pub const fn text_mention(user: User, offset: usize, length: usize) -> Self

Create a message entity representing a text mention.

Note

If you don’t have a complete User value, please use MessageEntity::text_mention_id instead.

pub fn text_mention_id(user_id: UserId, offset: usize, length: usize) -> Self

Create a message entity representing a text link in the form of tg://user/?id=... that mentions user with user_id.

pub const fn custom_emoji( custom_emoji_id: String, offset: usize, length: usize, ) -> Self

Create a message entity representing a custom emoji.

pub fn kind(self, val: MessageEntityKind) -> Self

pub const fn offset(self, val: usize) -> Self

pub const fn length(self, val: usize) -> Self

Trait Implementations

impl Clone for MessageEntity

fn clone(&self) -> MessageEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageEntity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageEntity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for MessageEntity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MessageEntity

fn eq(&self, other: &MessageEntity) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MessageEntity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MessageEntity

impl StructuralPartialEq for MessageEntity