botkit-core 0.1.0

Core abstractions for the botkit unified bot framework
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

use crate::response::Response;

/// Trait for converting types into bot responses
///
/// Similar to skyzen's `Responder` trait, this allows handlers to
/// return various types that get converted to responses.
///
/// # Example
/// ```ignore
/// // Return a string directly
/// async fn ping() -> &'static str {
///     "Pong!"
/// }
///
/// // Return a formatted string
/// async fn greet(user: User) -> String {
///     format!("Hello, {}!", user.name)
/// }
///
/// // Return Response for full control
/// async fn buttons() -> Response {
///     Response::text("Click a button:")
///         .with_components(vec![...])
/// }
/// ```
pub trait IntoResponse: Send {
    /// Convert this type into a bot response
    fn into_response(self) -> Response;
}

// String types
impl IntoResponse for String {
    fn into_response(self) -> Response {
        Response::text(self)
    }
}

impl IntoResponse for &'static str {
    fn into_response(self) -> Response {
        Response::text(self)
    }
}

impl IntoResponse for std::borrow::Cow<'static, str> {
    fn into_response(self) -> Response {
        Response::text(self)
    }
}

// Response passes through unchanged
impl IntoResponse for Response {
    fn into_response(self) -> Response {
        self
    }
}

// Unit type returns empty response
impl IntoResponse for () {
    fn into_response(self) -> Response {
        Response::empty()
    }
}

// Option<T> - None returns empty response
impl<T: IntoResponse> IntoResponse for Option<T> {
    fn into_response(self) -> Response {
        match self {
            Some(value) => value.into_response(),
            None => Response::empty(),
        }
    }
}

// Result<T, E> - Ok returns T, Err returns error message
impl<T: IntoResponse, E: std::fmt::Display + Send> IntoResponse for Result<T, E> {
    fn into_response(self) -> Response {
        match self {
            Ok(value) => value.into_response(),
            Err(e) => Response::text(format!("Error: {}", e)),
        }
    }
}

// File response
impl IntoResponse for async_fs::File {
    fn into_response(self) -> Response {
        Response::file(self)
    }
}

// File with caption (static str)
impl IntoResponse for (async_fs::File, &'static str) {
    fn into_response(self) -> Response {
        Response::file(self.0).with_caption(self.1)
    }
}

// File with caption (String)
impl IntoResponse for (async_fs::File, String) {
    fn into_response(self) -> Response {
        Response::file(self.0).with_caption(self.1)
    }
}