Struct tg_flows::Sticker

pub struct Sticker {
    pub file: FileMeta,
    pub width: u16,
    pub height: u16,
    pub kind: StickerKind,
    pub format: StickerFormat,
    pub thumb: Option<PhotoSize>,
    pub emoji: Option<String>,
    pub set_name: Option<String>,
}

This object represents a sticker.

The official docs.

Fields

file: FileMeta

Metadata of the sticker file.

width: u16

Sticker width, in pixels.

You can assume that max(width, height) = 512, min(width, height) <= 512. In other words one dimension is exactly 512 pixels and the other is at most 512 pixels.

height: u16

Sticker height, in pixels.

You can assume that max(width, height) = 512, min(width, height) <= 512. In other words one dimension is exactly 512 pixels and the other is at most 512 pixels.

kind: StickerKind

Kind of this sticker - regular, mask or custom emoji.

In other words this represent how the sticker is presented, as a big picture/video, as a mask while editing pictures or as a custom emoji in messages.

format: StickerFormat

Format of this sticker - raster/.webp, animated/.tgs or video/.webm.

In other words this represents how the sticker is encoded.

thumb: Option<PhotoSize>

Sticker thumbnail in the .webp or .jpg format.

emoji: Option<String>

Emoji associated with the sticker.

set_name: Option<String>

Name of the sticker set to which the sticker belongs.

Implementations

impl Sticker

pub fn is_raster(&self) -> bool

Returns true is this is a “normal” raster sticker.

Alias to self.format.is_raster().

pub fn is_animated(&self) -> bool

Returns true is this is an animated sticker.

Alias to self.format.is_animated().

pub fn is_video(&self) -> bool

Returns true is this is a video sticker.

Alias to self.format.is_video().

Methods from Deref<Target = StickerKind>

pub fn type_(&self) -> StickerType

Converts StickerKind to StickerType

pub fn is_regular(&self) -> bool

Returns true if the sticker kind is Regular.

pub fn is_mask(&self) -> bool

Returns true if the sticker kind is Mask.

pub fn is_custom_emoji(&self) -> bool

Returns true if the sticker kind is CustomEmoji.

pub fn premium_animation(&self) -> Option<&FileMeta>

Getter for StickerKind::Regular::premium_animation.

pub fn mask_position(&self) -> Option<MaskPosition>

Getter for StickerKind::Mask::mask_position.

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

Getter for StickerKind::CustomEmoji::custom_emoji_id.

Trait Implementations

impl Clone for Sticker

fn clone(&self) -> Sticker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sticker

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

Formats the value using the given formatter.

impl Deref for Sticker

This allows calling StickerKind’s methods directly on Sticker.

use teloxide_core::types::Sticker;

let sticker: Sticker = todo!();

let _ = sticker.is_regular();
let _ = sticker.kind.is_regular();

let _ = sticker.mask_position();
let _ = sticker.kind.mask_position();

type Target = StickerKind

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Sticker

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Sticker> for Sticker

fn eq(&self, other: &Sticker) -> 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 Serialize for Sticker

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Sticker