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
use super::Opt;
use super::Text;
use serde::Serialize;
/// [Option group object](https://api.slack.com/reference/block-kit/composition-objects#option_group)
/// representation.
///
/// # Example
///
/// ```
/// use slack_messaging::blocks::elements::{OptGroup, Opt};
/// use serde_json::json;
///
/// let options = OptGroup::new()
/// .label("Group One")
/// .push_option(
/// Opt::plain("This is a plain text.").set_value("value-0")
/// )
/// .push_option(
/// Opt::mrkdwn("*This is a mrkdwn text.*").set_value("value-1")
/// );
///
/// let expected = json!({
/// "label": {
/// "type": "plain_text",
/// "text": "Group One",
/// "emoji": true
/// },
/// "options": [
/// {
/// "text": {
/// "type": "plain_text",
/// "text": "This is a plain text.",
/// "emoji": true
/// },
/// "value": "value-0"
/// },
/// {
/// "text": {
/// "type": "mrkdwn",
/// "text": "*This is a mrkdwn text.*"
/// },
/// "value": "value-1"
/// },
/// ]
/// });
///
/// let options_json = serde_json::to_value(options).unwrap();
///
/// assert_eq!(options_json, expected);
/// ```
#[derive(Debug, Clone, Serialize)]
pub struct OptGroup {
label: Text,
options: Vec<Opt>,
}
impl Default for OptGroup {
fn default() -> Self {
Self {
label: Text::plain(""),
options: vec![],
}
}
}
impl OptGroup {
/// Constructs a Option group object with empty values.
///
/// ```
/// use slack_messaging::blocks::elements::OptGroup;
/// use serde_json::json;
///
/// let options = OptGroup::new();
///
/// let expected = json!({
/// "label": {
/// "type": "plain_text",
/// "text": "",
/// "emoji": true
/// },
/// "options": []
/// });
///
/// let options_json = serde_json::to_value(options).unwrap();
///
/// assert_eq!(options_json, expected);
/// ```
pub fn new() -> Self {
Self::default()
}
/// Sets label field with Text object.
///
/// ```
/// use slack_messaging::blocks::elements::{OptGroup, Text};
/// use serde_json::json;
///
/// let options = OptGroup::new().set_label(Text::plain("Group One"));
///
/// let expected = json!({
/// "label": {
/// "type": "plain_text",
/// "text": "Group One",
/// "emoji": true
/// },
/// "options": []
/// });
///
/// let options_json = serde_json::to_value(options).unwrap();
///
/// assert_eq!(options_json, expected);
/// ```
pub fn set_label(self, label: Text) -> Self {
Self { label, ..self }
}
/// Sets label field with string. This is a shorthand for `set_label` method.
///
/// ```
/// use slack_messaging::blocks::elements::OptGroup;
/// use serde_json::json;
///
/// let options = OptGroup::new().label("Group One");
///
/// let expected = json!({
/// "label": {
/// "type": "plain_text",
/// "text": "Group One",
/// "emoji": true
/// },
/// "options": []
/// });
///
/// let options_json = serde_json::to_value(options).unwrap();
///
/// assert_eq!(options_json, expected);
/// ```
pub fn label<T: Into<String>>(self, label: T) -> Self {
self.set_label(Text::plain(label))
}
/// Sets options field directly.
///
/// ```
/// use slack_messaging::blocks::elements::{OptGroup, Opt};
/// use serde_json::json;
///
/// let options = OptGroup::new()
/// .set_options(
/// vec![
/// Opt::plain("This is a plain text.").set_value("value-0"),
/// Opt::mrkdwn("*This is a mrkdwn text.*").set_value("value-1"),
/// ]
/// );
///
/// let expected = json!({
/// "label": {
/// "type": "plain_text",
/// "text": "",
/// "emoji": true
/// },
/// "options": [
/// {
/// "text": {
/// "type": "plain_text",
/// "text": "This is a plain text.",
/// "emoji": true
/// },
/// "value": "value-0"
/// },
/// {
/// "text": {
/// "type": "mrkdwn",
/// "text": "*This is a mrkdwn text.*"
/// },
/// "value": "value-1"
/// }
/// ]
/// });
///
/// let options_json = serde_json::to_value(options).unwrap();
///
/// assert_eq!(options_json, expected);
/// ```
pub fn set_options(self, options: Vec<Opt>) -> Self {
Self { options, ..self }
}
/// Adds Option object to options field.
///
/// ```
/// use slack_messaging::blocks::elements::{OptGroup, Opt};
/// use serde_json::json;
///
/// let options = OptGroup::new()
/// .push_option(Opt::plain("This is a plain text.").set_value("value-0"));
///
/// let expected = json!({
/// "label": {
/// "type": "plain_text",
/// "text": "",
/// "emoji": true
/// },
/// "options": [
/// {
/// "text": {
/// "type": "plain_text",
/// "text": "This is a plain text.",
/// "emoji": true
/// },
/// "value": "value-0"
/// }
/// ]
/// });
///
/// let options_json = serde_json::to_value(options).unwrap();
///
/// assert_eq!(options_json, expected);
/// ```
pub fn push_option(self, option: Opt) -> Self {
let Self { mut options, .. } = self;
options.push(option);
Self { options, ..self }
}
}