slack_messaging/blocks/rich_text/
quote.rs

1use crate::blocks::rich_text::types::RichTextElementType;
2use crate::validators::*;
3
4use serde::Serialize;
5use slack_messaging_derive::Builder;
6
7/// [Rich text quote element](https://docs.slack.dev/reference/block-kit/blocks/rich-text-block#rich_text_quote)
8/// representation.
9///
10/// # Fields and Validations
11///
12/// For more details, see the [official
13/// documentation](https://docs.slack.dev/reference/block-kit/blocks/rich-text-block#rich_text_quote).
14///
15/// | Field | Type | Required | Validation |
16/// |-------|------|----------|------------|
17/// | elements | Vec<[RichTextElementType]> | Yes | N/A |
18/// | border | i64 | No | N/A |
19///
20/// # Example
21///
22/// ```
23/// use slack_messaging::blocks::rich_text::prelude::*;
24/// # use std::error::Error;
25///
26/// # fn try_main() -> Result<(), Box<dyn Error>> {
27/// let quote = RichTextQuote::builder()
28///     .element(
29///         RichTextElementText::builder()
30///             .text("What we need is good examples in our documentation.")
31///             .build()?
32///     )
33///     .border(0)
34///     .build()?;
35///
36/// let expected = serde_json::json!({
37///     "type": "rich_text_quote",
38///     "elements": [
39///         {
40///             "type": "text",
41///             "text": "What we need is good examples in our documentation."
42///         }
43///     ],
44///     "border": 0
45/// });
46///
47/// let json = serde_json::to_value(quote).unwrap();
48///
49/// assert_eq!(json, expected);
50///
51/// // If your object has any validation errors, the build method returns Result::Err
52/// let quote = RichTextQuote::builder().build();
53/// assert!(quote.is_err());
54/// #     Ok(())
55/// # }
56/// # fn main() {
57/// #     try_main().unwrap()
58/// # }
59/// ```
60#[derive(Debug, Clone, Serialize, PartialEq, Builder)]
61#[serde(tag = "type", rename = "rich_text_quote")]
62pub struct RichTextQuote {
63    #[builder(push_item = "element", validate("required"))]
64    pub(crate) elements: Option<Vec<RichTextElementType>>,
65
66    #[serde(skip_serializing_if = "Option::is_none")]
67    pub(crate) border: Option<i64>,
68}
69
70#[cfg(test)]
71mod tests {
72    use super::*;
73    use crate::blocks::rich_text::types::test_helpers::*;
74    use crate::errors::*;
75
76    #[test]
77    fn it_implements_builder() {
78        let expected = RichTextQuote {
79            elements: Some(vec![el_text("foo"), el_emoji("bar")]),
80            border: Some(3),
81        };
82
83        let val = RichTextQuote::builder()
84            .set_elements(Some(vec![el_text("foo"), el_emoji("bar")]))
85            .set_border(Some(3))
86            .build()
87            .unwrap();
88
89        assert_eq!(val, expected);
90
91        let val = RichTextQuote::builder()
92            .elements(vec![el_text("foo"), el_emoji("bar")])
93            .border(3)
94            .build()
95            .unwrap();
96
97        assert_eq!(val, expected);
98    }
99
100    #[test]
101    fn it_implements_push_item_method() {
102        let expected = RichTextQuote {
103            elements: Some(vec![el_text("foo"), el_emoji("bar")]),
104            border: None,
105        };
106
107        let val = RichTextQuote::builder()
108            .element(text("foo"))
109            .element(emoji("bar"))
110            .build()
111            .unwrap();
112
113        assert_eq!(val, expected);
114    }
115
116    #[test]
117    fn it_requres_elements_field() {
118        let err = RichTextQuote::builder().build().unwrap_err();
119        assert_eq!(err.object(), "RichTextQuote");
120
121        let errors = err.field("elements");
122        assert!(errors.includes(ValidationErrorKind::Required));
123    }
124}
slack_messaging/blocks/rich_text/quote.rs

slack_messaging/blocks/rich_text/
quote.rs
