Struct tg_flows::MessageEntityRef

pub struct MessageEntityRef<'a> { /* private fields */ }

A “parsed” MessageEntity.

MessageEntity has offsets in UTF-16 code units, but in Rust we mostly work with UTF-8. In order to use an entity we need to convert UTF-16 offsets to UTF-8 ones. This type represents a message entity with converted offsets and a reference to the text.

You can get MessageEntityRefs by calling parse_entities and parse_caption_entities methods of Message or by calling MessageEntityRef::parse.

Implementations

impl<'a> MessageEntityRef<'a>

pub fn kind(&self) -> &'a MessageEntityKind

Returns kind of this entity.

pub fn text(&self) -> &'a str

Returns the text that this entity is related to.

pub fn range(&self) -> Range<usize>

Returns range that this entity is related to.

The range is in bytes for UTF-8 encoding i.e. you can use it with common Rust strings.

pub fn start(&self) -> usize

Returns the offset (in bytes, for UTF-8) to the start of this entity in the original message.

pub fn end(&self) -> usize

Returns the offset (in bytes, for UTF-8) to the end of this entity in the original message.

pub fn len(&self) -> usize

Returns the length of this entity in bytes for UTF-8 encoding.

pub fn message_text(&self) -> &'a str

Returns the full text of the original message.

pub fn parse(text: &'a str, entities: &'a [MessageEntity]) -> Vec<Self>

Parses telegram MessageEntitys converting offsets to UTF-8.

Trait Implementations

impl<'a> Clone for MessageEntityRef<'a>

fn clone(&self) -> MessageEntityRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for MessageEntityRef<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for MessageEntityRef<'a>

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<'a> PartialEq<MessageEntityRef<'a>> for MessageEntityRef<'a>

fn eq(&self, other: &MessageEntityRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Eq for MessageEntityRef<'a>

impl<'a> StructuralEq for MessageEntityRef<'a>

impl<'a> StructuralPartialEq for MessageEntityRef<'a>