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
use super::elements::Text;
use serde::Serialize;
/// [Image block](https://api.slack.com/reference/block-kit/blocks#image)
/// representation.
///
/// # Example
///
/// ```
/// use slack_messaging::blocks::Image;
/// use serde_json::json;
///
/// let image = Image::new()
/// .set_block_id("image4")
/// .title("Please enjoy this photo of a kitten")
/// .set_image_url("http://placekitten.com/500/500")
/// .set_alt_text("An incredibly cute kitten.");
///
/// let expected = json!({
/// "type": "image",
/// "block_id": "image4",
/// "title": {
/// "type": "plain_text",
/// "text": "Please enjoy this photo of a kitten",
/// "emoji": true
/// },
/// "image_url": "http://placekitten.com/500/500",
/// "alt_text": "An incredibly cute kitten."
/// });
///
/// let image_json = serde_json::to_value(image).unwrap();
///
/// assert_eq!(image_json, expected);
/// ```
#[derive(Debug, Clone, Serialize)]
pub struct Image {
#[serde(rename = "type")]
kind: &'static str,
image_url: String,
alt_text: String,
#[serde(skip_serializing_if = "Option::is_none")]
title: Option<Text>,
#[serde(skip_serializing_if = "Option::is_none")]
block_id: Option<String>,
}
impl Default for Image {
fn default() -> Self {
Self {
kind: "image",
image_url: "".to_string(),
alt_text: "".to_string(),
title: None,
block_id: None,
}
}
}
impl Image {
/// Constructs an Image block.
///
/// ```
/// use slack_messaging::blocks::Image;
/// use serde_json::json;
///
/// let image = Image::new();
///
/// let expected = json!({
/// "type": "image",
/// "image_url": "",
/// "alt_text": ""
/// });
///
/// let image_json = serde_json::to_value(image).unwrap();
///
/// assert_eq!(image_json, expected);
/// ```
pub fn new() -> Self {
Self::default()
}
/// Sets image_url field.
///
/// ```
/// use slack_messaging::blocks::Image;
/// use serde_json::json;
///
/// let image = Image::new().set_image_url("http://placekitten.com/500/500");
///
/// let expected = json!({
/// "type": "image",
/// "image_url": "http://placekitten.com/500/500",
/// "alt_text": ""
/// });
///
/// let image_json = serde_json::to_value(image).unwrap();
///
/// assert_eq!(image_json, expected);
/// ```
pub fn set_image_url<T: Into<String>>(self, url: T) -> Self {
Self {
image_url: url.into(),
..self
}
}
/// Sets alt_text field.
///
/// ```
/// use slack_messaging::blocks::Image;
/// use serde_json::json;
///
/// let image = Image::new().set_alt_text("An incredibly cute kitten.");
///
/// let expected = json!({
/// "type": "image",
/// "image_url": "",
/// "alt_text": "An incredibly cute kitten."
/// });
///
/// let image_json = serde_json::to_value(image).unwrap();
///
/// assert_eq!(image_json, expected);
/// ```
pub fn set_alt_text<T: Into<String>>(self, alt: T) -> Self {
Self {
alt_text: alt.into(),
..self
}
}
/// Sets title field.
///
/// ```
/// use slack_messaging::blocks::Image;
/// use slack_messaging::blocks::elements::Text;
/// use serde_json::json;
///
/// let image = Image::new()
/// .set_title(Text::plain("Please enjoy this photo of a kitten"));
///
/// let expected = json!({
/// "type": "image",
/// "title": {
/// "type": "plain_text",
/// "text": "Please enjoy this photo of a kitten",
/// "emoji": true
/// },
/// "image_url": "",
/// "alt_text": ""
/// });
///
/// let image_json = serde_json::to_value(image).unwrap();
///
/// assert_eq!(image_json, expected);
/// ```
pub fn set_title(self, text: Text) -> Self {
Self {
title: Some(text),
..self
}
}
/// Sets title field from string. This is a shorthand for `set_text` method.
///
/// ```
/// use slack_messaging::blocks::Image;
/// use serde_json::json;
///
/// let image = Image::new().title("Please enjoy this photo of a kitten");
///
/// let expected = json!({
/// "type": "image",
/// "title": {
/// "type": "plain_text",
/// "text": "Please enjoy this photo of a kitten",
/// "emoji": true
/// },
/// "image_url": "",
/// "alt_text": ""
/// });
///
/// let image_json = serde_json::to_value(image).unwrap();
///
/// assert_eq!(image_json, expected);
/// ```
pub fn title<T: Into<String>>(self, title: T) -> Self {
self.set_title(Text::plain(title))
}
/// Sets block_id field.
///
/// ```
/// use slack_messaging::blocks::Image;
/// use serde_json::json;
///
/// let image = Image::new().set_block_id("image4");
///
/// let expected = json!({
/// "type": "image",
/// "block_id": "image4",
/// "image_url": "",
/// "alt_text": ""
/// });
///
/// let image_json = serde_json::to_value(image).unwrap();
///
/// assert_eq!(image_json, expected);
/// ```
pub fn set_block_id<T: Into<String>>(self, block_id: T) -> Self {
Self {
block_id: Some(block_id.into()),
..self
}
}
}