foukoapi 0.1.0-alpha.1

Cross-platform bot framework in Rust. Write your handlers once, run the same bot on Telegram and Discord with shared accounts, embeds, keyboards and SQLite storage.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! Platform descriptors.
//!
//! A [`Platform`] is just a thin description of which adapter to spin up and
//! with what credentials. The actual driving logic lives in
//! [`crate::adapters`].

use std::fmt;

/// Which chat platform an update came from / should be dispatched to.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum PlatformKind {
    /// Telegram (MTProto Bot API).
    Telegram,
    /// Discord (gateway + REST).
    Discord,
}

impl fmt::Display for PlatformKind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::Telegram => "telegram",
            Self::Discord => "discord",
        })
    }
}

/// A platform the [`Bot`](crate::Bot) should run on.
///
/// Built through the short constructors: [`Platform::telegram`],
/// [`Platform::discord`]. Each one returns a `Platform` even if that
/// platform's feature is turned off at compile time - the missing
/// adapter will simply log a warning and be skipped when the bot
/// starts, instead of failing the build.
#[derive(Debug, Clone)]
pub struct Platform {
    pub(crate) kind: PlatformKind,
    pub(crate) config: PlatformConfig,
}

#[derive(Debug, Clone)]
#[non_exhaustive]
#[allow(dead_code)] // Fields are read only when the corresponding adapter feature is on.
pub(crate) enum PlatformConfig {
    /// Telegram bot token from @BotFather.
    Telegram { token: String },
    /// Discord bot token.
    Discord { token: String },
}

impl Platform {
    /// Add a Telegram bot. `token` is whatever BotFather gives you.
    pub fn telegram(token: impl Into<String>) -> Self {
        Self {
            kind: PlatformKind::Telegram,
            config: PlatformConfig::Telegram {
                token: token.into(),
            },
        }
    }

    /// Add a Discord bot.
    pub fn discord(token: impl Into<String>) -> Self {
        Self {
            kind: PlatformKind::Discord,
            config: PlatformConfig::Discord {
                token: token.into(),
            },
        }
    }

    /// Which kind of platform this descriptor points at.
    pub fn kind(&self) -> PlatformKind {
        self.kind
    }
}