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
use serde::{Deserialize, Serialize}; use validator::Validate; use crate::{compose::text, val_helpr::ValidationResult}; /// # Section Block /// /// _[slack api docs 🔗]_ /// /// Available in surfaces: /// - [modals 🔗] /// - [messages 🔗] /// - [home tabs 🔗] /// /// A `section` is one of the most flexible blocks available - /// it can be used as a simple text block, /// in combination with text fields, /// or side-by-side with any of the available [block elements 🔗] /// /// [slack api docs 🔗]: https://api.slack.com/reference/block-kit/blocks#section /// [modals 🔗]: https://api.slack.com/surfaces/modals /// [messages 🔗]: https://api.slack.com/surfaces/messages /// [home tabs 🔗]: https://api.slack.com/surfaces/tabs /// [block elements 🔗]: https://api.slack.com/reference/messaging/block-elements #[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize, Validate)] pub struct Contents { #[serde(skip_serializing_if = "Option::is_none")] #[validate(length(max = 10))] #[validate(custom = "validate::fields")] fields: Option<Vec<text::Text>>, #[serde(skip_serializing_if = "Option::is_none")] #[validate(custom = "validate::text")] text: Option<text::Text>, #[serde(skip_serializing_if = "Option::is_none")] #[validate(length(max = 255))] block_id: Option<String>, /// One of the available [element objects 🔗][element_objects]. /// /// [element_objects]: https://api.slack.com/reference/messaging/block-elements #[serde(skip_serializing_if = "Option::is_none")] accessory: Option<()>, } impl Contents { /// Construct a Section block from a collection of text objects /// /// # Arguments /// - `fields` - A collection of [text objects 🔗]. /// Any text objects included with fields will be /// rendered in a compact format that allows for /// 2 columns of side-by-side text. /// Maximum number of items is 10. /// Maximum length for the text in each item is 2000 characters. /// /// [text objects 🔗]: https://api.slack.com/reference/messaging/composition-objects#text /// /// # Errors /// Doesn't error. To validate your model against the length requirements, /// use the `validate` method. /// /// # Example /// ``` /// use slack_blocks::{blocks, compose::text}; /// /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// let fields = vec![text::Plain::from("Left column"), /// text::Plain::from("Right column"),]; /// /// let block = blocks::section::Contents::from_fields(fields); /// /// // < send to slack API > /// # Ok(()) /// # } /// ``` pub fn from_fields<FieldIter: IntoIterator<Item = impl Into<text::Text>>>( fields: FieldIter) -> Self { let fields = Some(fields.into_iter().map(|f| f.into()).collect()); Self { fields, text: None, block_id: None, accessory: None } } /// Construct a Section block from a text object /// /// # Arguments /// - `text` - The text for the block, in the form of a [text object 🔗]. /// Maximum length for the text in this field is 3000 characters. /// /// [text object 🔗]: https://api.slack.com/reference/messaging/composition-objects#text /// /// # Errors /// Doesn't error. To validate your model against the length requirements, /// use the `validate` method. /// /// # Example /// ``` /// use slack_blocks::{blocks, compose::text}; /// /// let block = /// blocks::section::Contents::from_text(text::Plain::from("I am a section!")); /// /// // < send to slack API > /// ``` pub fn from_text(text: impl Into<text::Text>) -> Self { Self { text: Some(text.into()), fields: None, block_id: None, accessory: None } } /// Set a unique `block_id` to identify this instance of an File Block. /// /// # 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, one will be generated. /// Maximum length for this field is 255 characters. /// `block_id` should be unique for each message and each iteration of a message. /// If a message is updated, use a new `block_id`. /// /// [identify the source of the action 🔗]: https://api.slack.com/interactivity/handling#payloads /// /// # example /// ``` /// use slack_blocks::blocks; /// /// # fn upload_file_to_slack(s: &str) -> String { String::new() } /// # use std::error::Error; /// # pub fn main() -> Result<(), Box<dyn Error>> { /// let file_id = upload_file_to_slack("https://www.cheese.com/cheese-wheel.png"); /// /// let block = blocks::file::Contents::from_external_id(file_id) /// .with_block_id("my_file_in_a_block_1234"); /// /// // < send to slack API > /// # Ok(()) /// # } /// ``` pub fn with_block_id(mut self, block_id: impl AsRef<str>) -> Self { self.block_id = Some(block_id.as_ref().to_string()); self } /// Validate that this Section block agrees with Slack's model requirements /// /// # Errors /// - If `from_fields` was called with more than 10 fields, /// or one of the fields contains text longer than /// 2000 chars /// - If `from_fields` was called with one of the fields /// containing text longer than 2000 chars /// - If `from_text` was called with text longer than /// 3000 chars /// - If `with_block_id` was called with a block id longer /// than 255 chars /// /// # Example /// ``` /// use slack_blocks::{blocks, compose::text}; /// /// let long_string = std::iter::repeat(' ').take(256).collect::<String>(); /// /// let block = blocks::section /// ::Contents /// ::from_text(text::Plain::from("file_id")) /// .with_block_id(long_string); /// /// assert_eq!(true, matches!(block.validate(), Err(_))); /// /// // < send to slack API > /// ``` pub fn validate(&self) -> ValidationResult { Validate::validate(self) } } mod validate { use crate::{compose::text, val_helpr::{below_len, ValidatorResult}}; pub(super) fn text(text: &text::Text) -> ValidatorResult { below_len("Section Text", 3000, text.as_ref()) } pub(super) fn fields(texts: &Vec<text::Text>) -> ValidatorResult { texts.iter() .map(|text| below_len("Section Field", 2000, text.as_ref())) .collect() } }