Struct botapi::gen_types::InputMediaAudio

pub struct InputMediaAudio {
    pub tg_type: String,
    pub media: Option<InputFile>,
    pub thumbnail: Option<InputFile>,
    pub caption: Option<String>,
    pub parse_mode: Option<String>,
    pub caption_entities: Option<Vec<MessageEntity>>,
    pub duration: Option<i64>,
    pub performer: Option<String>,
    pub title: Option<String>,
}

Represents an audio file to be treated as music to be sent.

Fields

tg_type: String

Type of the result, must be audio

media: Option<InputFile>

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files: https://core.telegram.org/bots/api#sending-files

thumbnail: Option<InputFile>

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files: https://core.telegram.org/bots/api#sending-files

caption: Option<String>

Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing

parse_mode: Option<String>

Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

caption_entities: Option<Vec<MessageEntity>>

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

duration: Option<i64>

Optional. Duration of the audio in seconds

performer: Option<String>

Optional. Performer of the audio

title: Option<String>

Optional. Title of the audio

Implementations

impl InputMediaAudio

pub fn noskip(self) -> NoSkipInputMediaAudio

impl InputMediaAudio

pub fn new(media: Option<InputFile>) -> Self

pub fn get_tg_type<'a>(&'a self) -> &'a str

Type of the result, must be audio

pub fn set_tg_type<'a>(&'a mut self, tg_type: String) -> &'a mut Self

Type of the result, must be audio

pub fn get_media<'a>(&'a self) -> &'a Option<InputFile>

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files: https://core.telegram.org/bots/api#sending-files

pub fn set_media<'a>(&'a mut self, media: Option<InputFile>) -> &'a mut Self

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files: https://core.telegram.org/bots/api#sending-files

pub fn get_thumbnail<'a>(&'a self) -> Option<&'a InputFile>

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files: https://core.telegram.org/bots/api#sending-files

pub fn set_thumbnail<'a>( &'a mut self, thumbnail: Option<InputFile>, ) -> &'a mut Self

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files: https://core.telegram.org/bots/api#sending-files

pub fn get_caption<'a>(&'a self) -> Option<&'a str>

Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing

pub fn set_caption<'a>(&'a mut self, caption: Option<String>) -> &'a mut Self

Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing

pub fn get_parse_mode<'a>(&'a self) -> Option<&'a str>

Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

pub fn set_parse_mode<'a>( &'a mut self, parse_mode: Option<String>, ) -> &'a mut Self

Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

pub fn get_caption_entities<'a>(&'a self) -> Option<&'a Vec<MessageEntity>>

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

pub fn set_caption_entities<'a>( &'a mut self, caption_entities: Option<Vec<MessageEntity>>, ) -> &'a mut Self

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode

pub fn get_duration<'a>(&'a self) -> Option<i64>

Optional. Duration of the audio in seconds

pub fn set_duration<'a>(&'a mut self, duration: Option<i64>) -> &'a mut Self

Optional. Duration of the audio in seconds

pub fn get_performer<'a>(&'a self) -> Option<&'a str>

Optional. Performer of the audio

pub fn set_performer<'a>( &'a mut self, performer: Option<String>, ) -> &'a mut Self

Optional. Performer of the audio

pub fn get_title<'a>(&'a self) -> Option<&'a str>

Optional. Title of the audio

pub fn set_title<'a>(&'a mut self, title: Option<String>) -> &'a mut Self

Optional. Title of the audio

Trait Implementations

impl Clone for InputMediaAudio

fn clone(&self) -> InputMediaAudio

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputMediaAudio

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

Formats the value using the given formatter.

impl Default for InputMediaAudio

fn default() -> InputMediaAudio

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InputMediaAudio

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BoxWrapper<Box<InputMediaAudio>>> for InputMediaAudio

fn from(t: BoxWrapper<Box<InputMediaAudio>>) -> Self

Converts to this type from the input type.

impl From<BoxWrapper<Unbox<InputMediaAudio>>> for InputMediaAudio

fn from(t: BoxWrapper<Unbox<InputMediaAudio>>) -> Self

Converts to this type from the input type.

impl From<NoSkipInputMediaAudio> for InputMediaAudio

fn from(t: NoSkipInputMediaAudio) -> Self

Converts to this type from the input type.

impl Hash for InputMediaAudio

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 Into<NoSkipInputMediaAudio> for InputMediaAudio

fn into(self) -> NoSkipInputMediaAudio

Converts this type into the (usually inferred) input type.

impl Ord for InputMediaAudio

fn cmp(&self, other: &InputMediaAudio) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for InputMediaAudio

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

fn partial_cmp(&self, other: &InputMediaAudio) -> 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 InputMediaAudio

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 InputMediaAudio

impl StructuralPartialEq for InputMediaAudio