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
use serde::{Deserialize, Serialize}; use std::convert::{TryFrom, TryInto}; use validator::Validate; use crate::block_elements; use crate::val_helpr::ValidationResult; /// # Actions Block /// /// _[slack api docs 🔗][action_docs]_ /// /// A block that is used to hold interactive [elements 🔗][block_elements] /// /// [block_elements]: https://api.slack.com/reference/messaging/block-elements /// [section_docs]: https://api.slack.com/reference/block-kit/blocks#actions #[derive(Clone, Debug, Default, Deserialize, Hash, PartialEq, Serialize, Validate)] pub struct Contents { /// An array of interactive [element objects 🔗] /// - [buttons 🔗] /// - [select menus 🔗] /// - [overflow menus 🔗] /// - [date pickers 🔗] /// /// There is a maximum of 5 elements in each action block. /// /// [element objects 🔗]: https://api.slack.com/reference/messaging/block-elements /// [buttons 🔗]: https://api.slack.com/reference/messaging/block-elements#button /// [select menus 🔗]: https://api.slack.com/reference/messaging/block-elements#select /// [overflow menus 🔗]: https://api.slack.com/reference/messaging/block-elements#overflow /// [date pickers 🔗]: https://api.slack.com/reference/messaging/block-elements#datepicker #[validate(length(max = 5))] elements: Vec<BlockElement>, /// 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 #[validate(length(max = 255))] block_id: Option<String>, } impl Contents { /// Create an empty Actions block /// (uses `Default`) pub fn new() -> Self { Default::default() } /// Set the `block_id` for interactions on an existing `actions::Contents` /// /// ``` /// use slack_blocks::blocks::{Block, actions}; /// /// pub fn main() { /// let actions = actions::Contents::new().with_block_id("tally_ho"); /// let block: Block = actions.into(); /// // < send block to slack's API > /// } /// ``` pub fn with_block_id<StrIsh: AsRef<str>>(mut self, block_id: StrIsh) -> Self { self.block_id = Some(block_id.as_ref().to_string()); self } /// Populate an Actions block with a collection of `BlockElement`s that /// may not be supported by `Actions` blocks. /// /// For an infallible version of this conversion function, see `from_action_elements`. /// /// ### Errors /// Errors if the `block_elements::BlockElement` is one that is not supported by /// `Actions` blocks. /// /// For a list of `BlockElement` types that are, see `self::BlockElement`. /// /// ### Runtime Validation /// /// **only** validates that the block elements are compatible with `Actions`, /// for full runtime model validation see the `validate` method. /// /// ``` /// use slack_blocks::blocks::{Block, actions}; /// use slack_blocks::compose; /// use slack_blocks::block_elements; /// /// pub fn main() -> Result<(), ()> { /// let btn = block_elements::BlockElement::Button; /// let actions = actions::Contents::from_elements(vec![btn])?; /// let block: Block = actions.into(); /// // < send block to slack's API > /// Ok(()) /// } /// ``` pub fn from_elements<Els: Into<Vec<block_elements::BlockElement>>>( elements: Els, ) -> Result<Self, ()> { elements // Into<Vec> .into() // Vec .try_into() // Result<Vec> } /// Populate an Actions block with a collection of `BlockElement`s that /// are supported by `Actions` blocks. /// /// For slightly easier to use (but fallible) version of this conversion function, /// see `from_action_elements`. /// /// ### Runtime Validation /// **only** validates that the block elements are compatible with `Actions`, /// for full runtime model validation see the `validate` method. /// /// ``` /// use slack_blocks::blocks::{Block, actions}; /// use slack_blocks::compose; /// use slack_blocks::block_elements; /// /// pub fn main() { /// let btn = actions::BlockElement::Button; /// let actions = actions::Contents::from_action_elements(vec![btn]); /// let block: Block = actions.into(); /// // < send block to slack's API > /// } /// ``` pub fn from_action_elements<Els: IntoIterator<Item = impl Into<self::BlockElement>>>( elements: Els, ) -> Self { elements .into_iter() .map(Into::<self::BlockElement>::into) .collect::<Vec<_>>() .into() } /// Validate the entire block and all of its /// elements against Slack's model requirements pub fn validate(&self) -> ValidationResult { Validate::validate(self) } } // TryFrom implementation backing `Contents::from_elements` impl TryFrom<Vec<block_elements::BlockElement>> for Contents { type Error = (); fn try_from(elements: Vec<block_elements::BlockElement>) -> Result<Self, Self::Error> { elements .into_iter() // Try to convert the bag of "any block element" to "block element supported by Actions" .map(TryInto::try_into) // If we hit one that is not supported, stop and continue with err .collect::<Result<_, _>>() // If it went ok, convert the supported elements into Contents .map(|els: Vec<self::BlockElement>| -> Self { els.into() }) } } // From implementation backing `Contents::from_action_elements` impl From<Vec<self::BlockElement>> for Contents { fn from(elements: Vec<self::BlockElement>) -> Self { Self { elements, ..Default::default() } } } #[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize)] pub enum BlockElement { Button, Checkboxes, DatePicker, OverflowMenu, PlainInput, RadioButtons, Select(block_elements::select::Contents), } impl TryFrom<block_elements::BlockElement> for self::BlockElement { type Error = (); fn try_from(el: block_elements::BlockElement) -> Result<Self, Self::Error> { use self::BlockElement::*; use block_elements::BlockElement as El; match el { El::Button => Ok(Button), El::Checkboxes => Ok(Checkboxes), El::DatePicker => Ok(DatePicker), El::OverflowMenu => Ok(OverflowMenu), El::PlainInput => Ok(PlainInput), El::RadioButtons => Ok(RadioButtons), El::Select(contents) => Ok(Select(contents)), _ => Err(()), } } }