Struct tgbot::types::Sticker

pub struct Sticker {

    pub file_id: String,
    pub file_unique_id: String,
    pub height: Integer,
    pub is_animated: bool,
    pub is_video: bool,
    pub sticker_type: StickerType,
    pub width: Integer,
    pub custom_emoji_id: Option<String>,
    pub emoji: Option<String>,
    pub file_size: Option<Integer>,
    pub mask_position: Option<MaskPosition>,
    pub needs_repainting: Option<bool>,
    pub premium_animation: Option<File>,
    pub set_name: Option<String>,
    pub thumbnail: Option<PhotoSize>,
}

Represents a sticker.

Fields

file_id: String

Identifier of the file.

Can be used to download or reuse the file.

file_unique_id: String

Unique identifier of the file.

It is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

height: Integer

Sticker height.

is_animated: bool

Indicates whether the sticker is animated.

is_video: bool

Indicates whether the sticker is a video sticker.

sticker_type: StickerType

Type of the sticker.

The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.

width: Integer

Sticker width.

custom_emoji_id: Option<String>

For custom emoji stickers, unique identifier of the custom emoji.

emoji: Option<String>

Emoji associated with the sticker.

file_size: Option<Integer>

File size in bytes.

mask_position: Option<MaskPosition>

For mask stickers, the position where the mask should be placed.

needs_repainting: Option<bool>

Indicates whether the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places.

premium_animation: Option<File>

For premium regular stickers, premium animation for the sticker.

set_name: Option<String>

Name of the sticker set to which the sticker belongs.

thumbnail: Option<PhotoSize>

Sticker thumbnail in the WEBP or JPEG format.

Implementations

impl Sticker

pub fn new<A, B>( file_id: A, file_unique_id: B, sticker_type: StickerType, height: Integer, width: Integer ) -> Self

where A: Into<String>, B: Into<String>,

Creates a new Sticker.

Arguments

• file_id - Identifier for the file.
• file_unique_id - Unique identifier for the file.
• sticker_type - Type of the sticker.
• height - Sticker height.
• width - Sticker width.

pub fn with_is_animated(self, value: bool) -> Self

Sets a new value for an is_animated flag.

Arguments

• value - Indicates whether the sticker is animated.

pub fn with_is_video(self, value: bool) -> Self

Sets a new value for an is_video flag.

Arguments

• value - Indicates whether the sticker is a video sticker.

pub fn with_custom_emoji_id<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new custom emoji ID.

Arguments

• value - Custom emoji ID.

pub fn with_emoji<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new emoji.

Arguments

• value - Emoji.

pub fn with_file_size(self, value: Integer) -> Self

Sets a new file size.

Arguments

• value - File size in bytes.

pub fn with_mask_position(self, value: MaskPosition) -> Self

Sets a new mask position.

Arguments

• value - Mask position.

pub fn with_needs_repainting(self, value: bool) -> Self

Sets a new value for a needs_repainting flag.

Arguments

• value - Value of the flag.

pub fn with_premium_animation(self, value: File) -> Self

Sets a new premium animation.

Arguments

• value - Premium animation.

pub fn with_set_name<T>(self, value: T) -> Self

where T: Into<String>,

Sets a new sticker set name.

Arguments

• value - Name of a sticker set.

pub fn with_thumbnail(self, value: PhotoSize) -> Self

Sets a new thumbnail.

Arguments

• value - Thumbnail.

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<'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 From<Sticker> for ExternalReplyData

fn from(original: Sticker) -> ExternalReplyData

Converts to this type from the input type.

impl PartialEq 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 PartialOrd for Sticker

fn partial_cmp(&self, other: &Sticker) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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