Struct pling::Telegram[−][src]

pub struct Telegram {
    pub bot_token: String,
    pub target_chat: TargetChat,
    pub disable_web_page_preview: bool,
    pub disable_notification: bool,
}

Expand description

Send a Telegram message

Documentation

https://core.telegram.org/bots/api#sendmessage

Needs to be compiled with feature http-sync or http-async

Usage TLDR

Create BOT_TOKEN via @BotFather in Telegram
Add the created bot to the chat/channel or write the bot a first message
Somehow obtain the Chat/User ID or Chat/Channel Username (TODO) that should receive the notification

Environment Variables

TELEGRAM_BOT_TOKEN (required)
TELEGRAM_TARGET_CHAT (required)
TELEGRAM_DISABLE_WEB_PAGE_PREVIEW (optional)
TELEGRAM_DISABLE_NOTIFICATION (optional)

Fields

bot_token: Stringtarget_chat: TargetChatdisable_web_page_preview: booldisable_notification: bool

Implementations

impl Telegram

pub const fn new(bot_token: String, target_chat: TargetChat) -> Self

pub fn from_env() -> Option<Self>

Loads the Telegram config from environment variables. The following variables are used:

TELEGRAM_BOT_TOKEN
TELEGRAM_TARGET_CHAT
TELEGRAM_DISABLE_WEB_PAGE_PREVIEW
TELEGRAM_DISABLE_NOTIFICATION

When TELEGRAM_BOT_TOKEN or TELEGRAM_TARGET_CHAT are unset None is returned.

pub fn send_sync(&self, text: &str) -> Result<(), Error>

Send a Telegram notification synchronously.

Errors

This method errors when the request could not be send or the not be handled by the Telegram API.

Trait Implementations

impl Clone for Telegram

fn clone(&self) -> Telegram

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl From<Telegram> for Notifier

fn from(tg: Telegram) -> Self

Performs the conversion.

impl PartialEq<Telegram> for Telegram

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

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

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

This method tests for !=.

impl Eq for Telegram

impl StructuralEq for Telegram

impl StructuralPartialEq for Telegram

Auto Trait Implementations

impl RefUnwindSafe for Telegram

impl Send for Telegram

impl Sync for Telegram

impl Unpin for Telegram

impl UnwindSafe for Telegram

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.