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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
//! # Text Object //! [_slack api docs 🔗_](https://api.slack.com/reference/block-kit/composition-objects#text) //! //! An object containing some text, //! formatted either as `plain_text` //! or using [`mrkdwn` 🔗](https://api.slack.com/reference/surfaces/formatting), //! our proprietary textual markup that's just different enough //! from Markdown to frustrate you. use serde::{Deserialize, Serialize}; use crate::convert; #[doc(inline)] pub mod mrkdwn; #[doc(inline)] pub mod plain; #[doc(inline)] pub use mrkdwn::Contents as Mrkdwn; #[doc(inline)] pub use plain::Contents as Plain; /// Convenience trait to provide a little more meaning than /// a call to `"foo".into()`, and shorter than `text::Plain::from("foo")` pub trait ToSlackPlaintext: Sized + Into<Plain> { /// Convert to slack plain_text fn plaintext(self) -> Plain { self.into() } } impl<T: Into<Plain>> ToSlackPlaintext for T {} /// Convenience trait to provide a little more meaning than /// a call to `"foo".into()`, and shorter than `text::Mrkdwn::from("foo")` pub trait ToSlackMarkdown: Sized + Into<Mrkdwn> { /// Convert to slack plain_text fn markdown(self) -> Mrkdwn { self.into() } } impl<T: Into<Mrkdwn>> ToSlackMarkdown for T {} /// # Text Object /// [_slack api docs 🔗_](https://api.slack.com/reference/block-kit/composition-objects#text) /// /// An object containing some text, /// formatted either as `plain_text` /// or using [`mrkdwn` 🔗](https://api.slack.com/reference/surfaces/formatting), /// our proprietary textual markup that's just different enough /// from Markdown to frustrate you. #[derive(Clone, Debug, Deserialize, Hash, PartialEq, Serialize)] #[serde(tag = "type", rename_all = "snake_case")] pub enum Text { /// Markdown text Mrkdwn(mrkdwn::Contents), /// Plain text #[serde(rename = "plain_text")] Plain(plain::Contents), } impl Text { /// Build a new Text object /// /// See TextBuilder for example pub fn builder() -> build::TextBuilderInit { build::TextBuilderInit::new() } /// Clone the data behind a reference, then convert it into /// a `Text` /// /// # Arguments /// - `contents` - Anything that can be cloned into a type /// that is convertable to a `Text` - this includes /// the `Plain` and `Mrkdwn` contents structs. /// Notably, this doesn't include a conversion directly /// from a reference to a `String` or a `&str` - that's /// because assuming which kind of text a string represents /// could lead to unexpected behavior when that kind of text /// isn't valid. pub fn copy_from<T: Into<Self> + Clone>(contents: &T) -> Self { contents.clone().into() } } convert!(impl From<mrkdwn::Contents> for Text => |contents| Text::Mrkdwn(contents)); convert!(impl From<plain::Contents> for Text => |contents| Text::Plain(contents)); /// Text builder pub mod build { use std::marker::PhantomData; use super::*; use crate::build::*; /// Builder methods #[allow(non_camel_case_types)] pub mod method { /// TextBuilder.text #[derive(Copy, Clone, Debug)] pub struct text; /// TextBuilder.plain or TextBuilder.mrkdwn #[derive(Copy, Clone, Debug)] pub struct plain_or_mrkdwn; } /// "Text Kind" for XML macro #[allow(non_camel_case_types)] #[cfg(feature = "blox")] #[cfg_attr(docsrs, doc(cfg(feature = "blox")))] pub mod kind { use super::*; // This trick is kind of nasty. Essentially, I want the API to look like // `<text plain>"Foo"</text>`, not `<text_plain>"Foo"</text_plain>`, // with an attribute setting the text kind. // // mox does not support nullary function attributes, so I _could_ make // `TextBuilder.plain()` and `TextBuilder.mrkdwn()` accept a unit argument, // but that would look fugly and impact non-XML use-cases. // (`<text plain=()>"Foo"</text>`, `Text::builder().plain(()).text("Foo").build()`) // // So I settled on having types named `mrkdwn` and `plain` exported from `crate::mox` // and a `TextMethod.kind()` method - // (`<text kind=mrkdwn></text>`) // this feels good to write, looks good to read, the only cons are implementation complexity // and potential clash with locals named `mrkdwn` or `plain`. /// Static marker trait tying the token "mrkdwn" to the type "Mrkdwn", /// and "plain" to "Plain" pub trait TextKind<T> { /// Invoke `TextBuilder.mrkdwn` or `TextBuilder.plain` fn set_kind<M>(self, builder: TextBuilder<Text, M>) -> TextBuilder<T, M>; } /// Markdown text #[derive(Copy, Clone, Debug)] pub struct mrkdwn; /// Plain text #[derive(Copy, Clone, Debug)] pub struct plain; impl TextKind<Mrkdwn> for mrkdwn { fn set_kind<M>(self, builder: TextBuilder<Text, M>) -> TextBuilder<Mrkdwn, M> { builder.mrkdwn() } } impl TextKind<Plain> for plain { fn set_kind<M>(self, builder: TextBuilder<Text, M>) -> TextBuilder<Plain, M> { builder.plain() } } } /// Initial state for Text Builder pub type TextBuilderInit = TextBuilder<Text, RequiredMethodNotCalled<method::text>>; /// # Text Builder /// /// Allows you to construct safely, with compile-time checks /// on required setter methods. /// /// # Required Methods /// `TextBuilder::build()` is only available if these methods have been called: /// - `text` /// - `plain` or `mrkdwn` /// /// ``` /// use slack_blocks::text::Text; /// /// let foo = Text::builder().plain().text("foo").build(); /// ``` #[derive(Debug)] pub struct TextBuilder<T, TMarker> { text: Option<Text>, text_value: Option<String>, state: PhantomData<(T, TMarker)>, } impl<T> TextBuilder<T, RequiredMethodNotCalled<method::text>> { /// Construct a new text builder pub fn new() -> Self { Self { text: None, text_value: None, state: PhantomData::<_> } } /// Set `text` (**Required**) /// /// The text contents to render for this `Text` object. /// /// For some basic formatting examples, see the docs for /// the `text::Mrkdwn`, or [Slack's markdown docs 🔗]. /// /// There are no intrinsic length limits on this, those are usually /// requirements of the context the text will be used in. /// /// [Slack's markdown docs 🔗]: https://api.slack.com/reference/surfaces/formatting pub fn text(mut self, t: impl AsRef<str>) -> TextBuilder<T, Set<method::text>> { let text = t.as_ref().to_string(); match self.text { | Some(Text::Mrkdwn(ref mut t)) => { t.text = text; }, | Some(Text::Plain(ref mut t)) => { t.text = text; }, | None => self.text_value = Some(text), }; TextBuilder { text: self.text, text_value: self.text_value, state: PhantomData::<_> } } /// Alias of `text` for XML macros, allowing text /// to be set as a string literal instead of an attribute. /// /// ``` /// use slack_blocks::blox::*; /// /// let as_attr = blox! { /// <text kind=plain text="Foo" /> /// }; /// /// let as_child = blox! { /// <text kind=plain>"Foo"</text> /// }; /// /// assert_eq!(as_attr, as_child); /// ``` #[cfg(feature = "blox")] #[cfg_attr(docsrs, doc(cfg(feature = "blox")))] pub fn child(self, t: impl AsRef<str>) -> TextBuilder<T, Set<method::text>> { self.text(t) } } impl<M> TextBuilder<Text, M> { /// Set the kind of the text you're building (**Required**) /// /// Intended to be used as an XML attribute with `build::kind::mrkdwn` or `build::kind::plain` /// /// ``` /// use slack_blocks::{blox::*, text}; /// /// let xml = blox! {<text kind=plain>"Foo"</text>}; /// /// let builder = text::Plain::from("Foo"); /// /// assert_eq!(xml, builder) /// ``` #[cfg(feature = "blox")] #[cfg_attr(docsrs, doc(cfg(feature = "blox")))] pub fn kind<T, K>(self, kind: K) -> TextBuilder<T, M> where T: Into<Text>, K: kind::TextKind<T> { kind.set_kind(self) } /// Set the text you're building to be `plain_text` (**Required**) pub fn plain(self) -> TextBuilder<Plain, M> { let text = Some(Plain::from(self.text_value.unwrap_or_default()).into()); TextBuilder { text, text_value: None, state: PhantomData::<_> } } /// Set the text you're building to be `mrkdwn` (**Required**) pub fn mrkdwn(self) -> TextBuilder<Mrkdwn, M> { let text = Some(Mrkdwn::from(self.text_value.unwrap_or_default()).into()); TextBuilder { text, text_value: None, state: PhantomData::<_> } } } impl<M> TextBuilder<Mrkdwn, M> { /// Set `verbatim` (Optional) /// /// When set to false (as is default) /// URLs will be auto-converted into links, /// conversation names will be link-ified, /// and certain mentions will be automatically parsed. /// /// Using a value of true will skip any preprocessing /// of this nature, although you can /// still include manual parsing strings. pub fn verbatim(mut self, verbatim: bool) -> Self { if let Some(Text::Mrkdwn(ref mut m)) = self.text { m.verbatim = Some(verbatim); } self } } impl<M> TextBuilder<Plain, M> { /// Set `emoji` (Optional) /// /// Indicates whether emojis in a text field should be /// escaped into the colon emoji format pub fn emoji(mut self, emoji: bool) -> Self { if let Some(Text::Plain(ref mut p)) = self.text { p.emoji = Some(emoji); } self } } impl TextBuilder<Plain, Set<method::text>> { /// All done building, now give me a darn text object! /// /// > `no method name 'build' found for struct 'TextBuilder<...>'`? /// Make sure all required setter methods have been called. See docs for `TextBuilder`. /// /// ```compile_fail /// use slack_blocks::text::Text; /// /// let foo = Text::builder().build(); // Won't compile! /// ``` /// /// ``` /// use slack_blocks::text::Text; /// /// let foo = Text::builder().plain() /// .emoji(true) /// .text("foo :joy:") /// .build(); /// ``` pub fn build(self) -> Plain { match self.text.unwrap() { | Text::Plain(p) => p, | _ => unreachable!("type marker says this should be plain."), } } } impl TextBuilder<Mrkdwn, Set<method::text>> { /// All done building, now give me a darn text object! /// /// > `no method name 'build' found for struct 'TextBuilder<...>'`? /// Make sure all required setter methods have been called. See docs for `TextBuilder`. /// /// ```compile_fail /// use slack_blocks::text::Text; /// /// let foo = Text::builder().build(); // Won't compile! /// ``` /// /// ``` /// use slack_blocks::text::Text; /// /// let foo = Text::builder().mrkdwn() /// .verbatim(true) /// .text("foo :joy:") /// .build(); /// ``` pub fn build(self) -> Mrkdwn { match self.text.unwrap() { | Text::Mrkdwn(p) => p, | _ => unreachable!("type marker says this should be markdown."), } } } } impl AsRef<str> for Text { fn as_ref(&self) -> &str { match self { | Self::Mrkdwn(cts) => cts.as_ref(), | Self::Plain(cts) => cts.as_ref(), } } }