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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
//! # Image Block //! //! _[slack api docs 🔗]_ //! //! A simple image block, designed to make those cat photos really pop. //! //! [slack api docs 🔗]: https://api.slack.com/reference/block-kit/blocks#image use std::borrow::Cow; use serde::{Deserialize, Serialize}; use validator::Validate; use crate::{compose::text, val_helpr::ValidationResult}; /// # Image Block /// /// _[slack api docs 🔗]_ /// /// A simple image block, designed to make those cat photos really pop. /// /// [slack api docs 🔗]: https://api.slack.com/reference/block-kit/blocks#image #[derive(Clone, Debug, Default, Deserialize, Hash, PartialEq, Serialize, Validate)] pub struct Image<'a> { #[validate(length(max = 3000))] image_url: Cow<'a, str>, #[validate(length(max = 2000))] alt_text: Cow<'a, str>, #[serde(skip_serializing_if = "Option::is_none")] #[validate(custom = "validate::title")] title: Option<text::Text>, #[serde(skip_serializing_if = "Option::is_none")] #[validate(custom = "super::validate_block_id")] block_id: Option<Cow<'a, str>>, } impl<'a> Image<'a> { /// Build a new Image block. /// /// For example, see docs for ImageBuilder. pub fn builder() -> build::ImageBuilderInit<'a> { build::ImageBuilderInit::new() } /// Create an image block, with a url and a brief description for /// situations where the image cannot be rendered. /// /// # Arguments /// - `alt_text` - A plain-text summary of the image. /// This should not contain any markup. /// Maximum length for this field is 2000 characters. /// /// - `image_url` - The URL of the image to be displayed. /// Maximum length for this field is 3000 characters. /// /// # Example /// ``` /// use slack_blocks::blocks::{Block, Image}; /// /// let url = "https://www.cheese.com/favicon.ico"; /// let image: Block = /// Image::from_alt_text_and_url("a small image of cheese.", url).into(); /// /// // < send to slack api > /// ``` #[deprecated(since = "0.19.4", note = "use Image::builder")] pub fn from_alt_text_and_url(alt_text: impl Into<Cow<'a, str>>, image_url: impl Into<Cow<'a, str>>) -> Self { Self { alt_text: alt_text.into(), image_url: image_url.into(), title: None, block_id: None } } /// Set a plain-text title to be displayed next to your image /// /// # Arguments /// - title - An optional title for the image in the form of a /// Plaintext [text object 🔗]. /// Maximum length for the text in this field is 2000 characters. /// /// [text object 🔗]: https://api.slack.com/reference/messaging/composition-objects#text /// /// # Example /// ``` /// use slack_blocks::blocks::{Block, Image}; /// /// let url = "https://www.cheese.com/favicon.ico"; /// let image: Block = Image::from_alt_text_and_url("a small image of cheese.", url) /// .with_title("here is an image of some cheese:") /// .into(); /// /// // < send block to slack's API > /// ``` #[deprecated(since = "0.19.4", note = "use Image::builder")] pub fn with_title(mut self, title: impl Into<text::Plain>) -> Self { self.title = Some(title.into().into()); self } /// Set the `block_id` for interactions on an existing `Image` /// /// # Arguments /// - `block_id` - A string acting as a unique identifier for a block. /// You can use this `block_id` when you receive an interaction payload /// to [identify the source of the action 🔗]. /// If not specified, a `block_id` will be generated. /// Maximum length for this field is 255 characters. /// /// [identify the source of the action 🔗]: https://api.slack.com/interactivity/handling#payloads /// /// # Example /// ``` /// use slack_blocks::blocks::{Block, Image}; /// /// let url = "https://www.cheese.com/favicon.ico"; /// let image: Block = Image::from_alt_text_and_url("a small image of cheese.", url) /// .with_title("here is an image of some cheese:") /// .with_block_id("msg_id_12346") /// .into(); /// /// // < send block to slack's API > /// ``` #[deprecated(since = "0.19.4", note = "use Image::builder")] pub fn with_block_id(mut self, block_id: impl Into<Cow<'a, str>>) -> Self { self.block_id = Some(block_id.into()); self } /// Validate that this Image block agrees with Slack's model requirements /// /// # Errors /// - If `with_block_id` was called with a block id longer /// than 255 chars /// - If `with_title` was called with a title longer /// than 2000 chars /// - If `from_url_and_alt_text` was called with `alt_text` longer /// than 2000 chars /// - If `from_url_and_alt_text` was called with `image_url` longer /// than 3000 chars /// /// # Example /// ``` /// use slack_blocks::blocks; /// /// let long_string = std::iter::repeat(' ').take(256).collect::<String>(); /// /// let block = /// blocks::Image::from_alt_text_and_url("", "").with_block_id(long_string); /// /// assert_eq!(true, matches!(block.validate(), Err(_))); /// ``` pub fn validate(&self) -> ValidationResult { Validate::validate(self) } } /// File block builder pub mod build { use std::marker::PhantomData; use super::*; use crate::build::*; /// Compile-time markers for builder methods #[allow(non_camel_case_types)] pub mod method { /// ImageBuilder.image_url or src #[derive(Clone, Copy, Debug)] pub struct url; /// ImageBuilder.alt_text or alt #[derive(Clone, Copy, Debug)] pub struct alt; } /// Initial state for `ImageBuilder` pub type ImageBuilderInit<'a> = ImageBuilder<'a, RequiredMethodNotCalled<method::url>, RequiredMethodNotCalled<method::alt>>; /// Build an Image block /// /// Allows you to construct safely, with compile-time checks /// on required setter methods. /// /// # Required Methods /// `ImageBuilder::build()` is only available if these methods have been called: /// - `external_id` /// - `source` /// /// # Example /// ``` /// use slack_blocks::{blocks::Image, text::ToSlackPlaintext}; /// /// let block = Image::builder().image_url("https://foo.com/bar.png") /// .alt_text("pic of bar") /// .build(); /// ``` #[derive(Debug)] pub struct ImageBuilder<'a, Url, Alt> { image_url: Option<Cow<'a, str>>, alt_text: Option<Cow<'a, str>>, title: Option<text::Text>, block_id: Option<Cow<'a, str>>, state: PhantomData<(Url, Alt)>, } impl<'a, Url, Alt> ImageBuilder<'a, Url, Alt> { /// Create a new ImageBuilder pub fn new() -> Self { Self { image_url: None, alt_text: None, title: None, block_id: None, state: PhantomData::<_> } } /// Set `title` (Optional) /// /// An optional title for the image in the form of a /// Plaintext [text object 🔗]. /// /// Maximum length for the text in this field is 2000 characters. /// /// [text object 🔗]: https://api.slack.com/reference/messaging/composition-objects#text pub fn title<T>(mut self, text: T) -> Self where T: Into<text::Plain> { self.title = Some(text.into().into()); self } /// Set `image_url` (**Required**) /// /// The URL of the image to be displayed. /// /// Maximum length for this field is 3000 characters. pub fn image_url<S>(self, image_url: S) -> ImageBuilder<'a, Set<method::url>, Alt> where S: Into<Cow<'a, str>> { ImageBuilder { image_url: Some(image_url.into()), alt_text: self.alt_text, title: self.title, block_id: self.block_id, state: PhantomData::<_> } } /// Set `alt_text` (**Required**) /// /// A plain-text summary of the image. /// /// This should not contain any markup. /// /// Maximum length for this field is 2000 characters. pub fn alt_text<S>(self, alt_text: S) -> ImageBuilder<'a, Url, Set<method::alt>> where S: Into<Cow<'a, str>> { ImageBuilder { alt_text: Some(alt_text.into()), image_url: self.image_url, title: self.title, block_id: self.block_id, state: PhantomData::<_> } } /// Set `block_id` (Optional) /// /// A string acting as a unique identifier for a block. /// /// You can use this `block_id` when you receive an interaction payload /// to [identify the source of the action 🔗]. /// /// If not specified, a `block_id` will be generated. /// /// Maximum length for this field is 255 characters. /// /// [identify the source of the action 🔗]: https://api.slack.com/interactivity/handling#payloads pub fn block_id<S>(mut self, block_id: S) -> Self where S: Into<Cow<'a, str>> { self.block_id = Some(block_id.into()); self } } impl<'a> ImageBuilder<'a, Set<method::url>, Set<method::alt>> { /// All done building, now give me a darn actions block! /// /// > `no method name 'build' found for struct 'ImageBuilder<...>'`? /// Make sure all required setter methods have been called. See docs for `ImageBuilder`. /// /// ```compile_fail /// use slack_blocks::blocks::Image; /// /// let foo = Image::builder().build(); // Won't compile! /// ``` /// /// ``` /// use slack_blocks::{blocks::Image, compose::text::ToSlackPlaintext}; /// /// let block = Image::builder().image_url("https://foo.com/bar.png") /// .alt_text("pic of bar") /// .build(); /// ``` pub fn build(self) -> Image<'a> { Image { image_url: self.image_url.unwrap(), alt_text: self.alt_text.unwrap(), title: self.title, block_id: self.block_id } } } } mod validate { use crate::{compose::text, val_helpr::{below_len, ValidatorResult}}; pub(super) fn title(text: &text::Text) -> ValidatorResult { below_len("Image Title", 2000, text.as_ref()) } }