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
use super::Text;
use serde::Serialize;
/// [Option object](https://api.slack.com/reference/block-kit/composition-objects#option)
/// representation.
///
/// # Example
///
/// ```
/// use slack_messaging::blocks::elements::{Opt, Text};
/// use serde_json::json;
///
/// let option = Opt::new()
/// .set_text(Text::plain("Maru"))
/// .set_value("maru");
///
/// let expected = json!({
/// "text": {
/// "type": "plain_text",
/// "text": "Maru",
/// "emoji": true
/// },
/// "value": "maru"
/// });
///
/// let option_json = serde_json::to_value(option).unwrap();
///
/// assert_eq!(option_json, expected);
/// ```
#[derive(Debug, Clone, Serialize)]
pub struct Opt {
text: Text,
value: String,
#[serde(skip_serializing_if = "Option::is_none")]
description: Option<Text>,
#[serde(skip_serializing_if = "Option::is_none")]
url: Option<String>,
}
impl Default for Opt {
fn default() -> Self {
Self {
text: Text::plain(""),
value: "".into(),
description: None,
url: None,
}
}
}
impl Opt {
/// Constructs a Option object with empty values.
///
/// ```
/// use slack_messaging::blocks::elements::Opt;
/// use serde_json::{json, Value};
///
/// let option = Opt::new();
///
/// let option_json = serde_json::to_value(option).unwrap();
///
/// assert_eq!(option_json["text"]["text"], Value::String("".into()));
/// assert_eq!(option_json["value"], Value::String("".into()));
/// assert_eq!(option_json["description"], Value::Null);
/// assert_eq!(option_json["url"], Value::Null);
/// ```
pub fn new() -> Self {
Self::default()
}
/// Constructs a Option object with plain_text object.
///
/// ```
/// use slack_messaging::blocks::elements::Opt;
/// use serde_json::json;
///
/// let option = Opt::plain("This is a plain text.");
///
/// let expected = json!({
/// "text": {
/// "type": "plain_text",
/// "text": "This is a plain text.",
/// "emoji": true
/// },
/// "value": ""
/// });
///
/// let option_json = serde_json::to_value(option).unwrap();
///
/// assert_eq!(option_json, expected);
/// ```
pub fn plain<T: Into<String>>(text: T) -> Self {
Self::new().set_text(Text::plain(text))
}
/// Constructs a Option object with mrkdwn object.
///
/// ```
/// use slack_messaging::blocks::elements::Opt;
/// use serde_json::json;
///
/// let option = Opt::mrkdwn("This is a ~plain~markdown text.");
///
/// let expected = json!({
/// "text": {
/// "type": "mrkdwn",
/// "text": "This is a ~plain~markdown text."
/// },
/// "value": ""
/// });
///
/// let option_json = serde_json::to_value(option).unwrap();
///
/// assert_eq!(option_json, expected);
/// ```
pub fn mrkdwn<T: Into<String>>(text: T) -> Self {
Self::new().set_text(Text::mrkdwn(text))
}
/// Sets text field.
///
/// ```
/// use slack_messaging::blocks::elements::{Opt, Text};
/// use serde_json::json;
///
/// let option = Opt::new()
/// .set_text(Text::plain("This is a plain text."));
///
/// let expected = json!({
/// "text": {
/// "type": "plain_text",
/// "text": "This is a plain text.",
/// "emoji": true
/// },
/// "value": ""
/// });
///
/// let option_json = serde_json::to_value(option).unwrap();
///
/// assert_eq!(option_json, expected);
/// ```
pub fn set_text(self, text: Text) -> Self {
Self { text, ..self }
}
/// Sets text field.
///
/// ```
/// use slack_messaging::blocks::elements::Opt;
/// use serde_json::json;
///
/// let option = Opt::new().set_value("valueeeeeee");
///
/// let expected = json!({
/// "text": {
/// "type": "plain_text",
/// "text": "",
/// "emoji": true
/// },
/// "value": "valueeeeeee"
/// });
///
/// let option_json = serde_json::to_value(option).unwrap();
///
/// assert_eq!(option_json, expected);
/// ```
pub fn set_value<T: Into<String>>(self, value: T) -> Self {
Self {
value: value.into(),
..self
}
}
/// Sets description field with plain_text object.
///
/// ```
/// use slack_messaging::blocks::elements::Opt;
/// use serde_json::json;
///
/// let option = Opt::new().set_description("This is a description.");
///
/// let expected = json!({
/// "text": {
/// "type": "plain_text",
/// "text": "",
/// "emoji": true
/// },
/// "value": "",
/// "description": {
/// "type": "plain_text",
/// "text": "This is a description.",
/// "emoji": true
/// }
/// });
///
/// let option_json = serde_json::to_value(option).unwrap();
///
/// assert_eq!(option_json, expected);
/// ```
pub fn set_description<T: Into<String>>(self, description: T) -> Self {
Self {
description: Some(Text::plain(description)),
..self
}
}
/// Sets url field.
///
/// ```
/// use slack_messaging::blocks::elements::Opt;
/// use serde_json::{json, Value};
///
/// let option = Opt::new().set_url("https://google.com");
/// let option_json = serde_json::to_value(option).unwrap();
///
/// assert_eq!(option_json["url"], Value::String("https://google.com".into()));
/// ```
pub fn set_url<T: Into<String>>(self, url: T) -> Self {
Self {
url: Some(url.into()),
..self
}
}
}