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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
use super::elements::{Image, Text};
use serde::Serialize;
/// [Context block](https://api.slack.com/reference/block-kit/blocks#context)
/// representation.
///
/// # Example
///
/// The following is reproduction of [the sample context](https://api.slack.com/reference/block-kit/blocks#context_examples).
///
/// ```
/// use slack_messaging::blocks::Context;
/// use slack_messaging::blocks::elements::{Image, Text};
/// use serde_json::json;
///
/// let context = Context::new()
/// .push_element(
/// Image::new()
/// .set_image_url("https://image.freepik.com/free-photo/red-drawing-pin_1156-445.jpg")
/// .set_alt_text("images")
/// )
/// .push_element(
/// Text::mrkdwn("Location: **Dogpatch**")
/// );
///
/// let expected = json!({
/// "type": "context",
/// "elements": [
/// {
/// "type": "image",
/// "image_url": "https://image.freepik.com/free-photo/red-drawing-pin_1156-445.jpg",
/// "alt_text": "images"
/// },
/// {
/// "type": "mrkdwn",
/// "text": "Location: **Dogpatch**"
/// }
/// ]
/// });
///
/// let context_json = serde_json::to_value(context).unwrap();
///
/// assert_eq!(context_json, expected);
/// ```
#[derive(Debug, Clone, Serialize)]
pub struct Context {
#[serde(rename = "type")]
kind: &'static str,
elements: Vec<ContextElement>,
#[serde(skip_serializing_if = "Option::is_none")]
block_id: Option<String>,
}
impl Default for Context {
fn default() -> Self {
Self {
kind: "context",
elements: vec![],
block_id: None,
}
}
}
impl Context {
/// Constructs a Context block.
///
/// ```
/// use slack_messaging::blocks::Context;
/// use serde_json::json;
///
/// let context = Context::new();
///
/// let expected = json!({
/// "type": "context",
/// "elements": []
/// });
///
/// let context_json = serde_json::to_value(context).unwrap();
///
/// assert_eq!(context_json, expected);
/// ```
pub fn new() -> Self {
Self::default()
}
/// Sets elements field directly. The argument is a vector composed from any objects
/// that can transform into the enum [ContextElement].
///
/// ```
/// use slack_messaging::blocks::Context;
/// use slack_messaging::blocks::elements::{Image, Text};
/// use serde_json::json;
///
/// let context = Context::new()
/// .set_elements(
/// vec![
/// Image::new()
/// .set_image_url("https://image.freepik.com/free-photo/red-drawing-pin_1156-445.jpg")
/// .set_alt_text("images")
/// .into(),
/// Text::mrkdwn("Location: **Dogpatch**").into()
/// ]
/// );
///
/// let expected = json!({
/// "type": "context",
/// "elements": [
/// {
/// "type": "image",
/// "image_url": "https://image.freepik.com/free-photo/red-drawing-pin_1156-445.jpg",
/// "alt_text": "images"
/// },
/// {
/// "type": "mrkdwn",
/// "text": "Location: **Dogpatch**"
/// }
/// ]
/// });
///
/// let context_json = serde_json::to_value(context).unwrap();
///
/// assert_eq!(context_json, expected);
/// ```
pub fn set_elements(self, elements: Vec<ContextElement>) -> Self {
Self { elements, ..self }
}
/// Adds an object to elements field. The argument is an any object
/// that can transform into the enum [ContextElement].
///
/// ```
/// use slack_messaging::blocks::Context;
/// use slack_messaging::blocks::elements::{Image, Text};
/// use serde_json::json;
///
/// let context = Context::new()
/// .push_element(
/// Image::new()
/// .set_image_url("https://image.freepik.com/free-photo/red-drawing-pin_1156-445.jpg")
/// .set_alt_text("images")
/// )
/// .push_element(
/// Text::mrkdwn("Location: **Dogpatch**")
/// );
///
/// let expected = json!({
/// "type": "context",
/// "elements": [
/// {
/// "type": "image",
/// "image_url": "https://image.freepik.com/free-photo/red-drawing-pin_1156-445.jpg",
/// "alt_text": "images"
/// },
/// {
/// "type": "mrkdwn",
/// "text": "Location: **Dogpatch**"
/// }
/// ]
/// });
///
/// let context_json = serde_json::to_value(context).unwrap();
///
/// assert_eq!(context_json, expected);
/// ```
pub fn push_element<T: Into<ContextElement>>(self, element: T) -> Self {
let mut elements = self.elements;
elements.push(element.into());
Self { elements, ..self }
}
/// Sets block_id field.
///
/// ```
/// use slack_messaging::blocks::Context;
/// use serde_json::json;
///
/// let context = Context::new().set_block_id("context_block_1");
///
/// let expected = json!({
/// "type": "context",
/// "elements": [],
/// "block_id": "context_block_1"
/// });
///
/// let context_json = serde_json::to_value(context).unwrap();
///
/// assert_eq!(context_json, expected);
/// ```
pub fn set_block_id<T: Into<String>>(self, block_id: T) -> Self {
Self {
block_id: Some(block_id.into()),
..self
}
}
}
/// Objects that can be an element of the [Context]'s elements field.
#[derive(Debug, Clone, Serialize)]
#[serde(untagged)]
pub enum ContextElement {
/// [Image element](https://api.slack.com/reference/block-kit/block-elements#image)
/// representation
Image(Box<Image>),
/// [Text object](https://api.slack.com/reference/block-kit/composition-objects#text)
/// representation
Text(Box<Text>),
}
impl From<Image> for ContextElement {
fn from(value: Image) -> Self {
Self::Image(Box::new(value))
}
}
impl From<Text> for ContextElement {
fn from(value: Text) -> Self {
Self::Text(Box::new(value))
}
}