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

use super::elements::Text;
use serde::Serialize;

/// [Header block](https://api.slack.com/reference/block-kit/blocks#header)
/// representation.
///
/// # Example
///
/// ```
/// use slack_messaging::blocks::Header;
/// use serde_json::json;
///
/// let header = Header::new()
///     .text("Budget Performance")
///     .set_block_id("header_1");
///
/// let expected = json!({
///     "type": "header",
///     "block_id": "header_1",
///     "text": {
///         "type": "plain_text",
///         "text": "Budget Performance",
///         "emoji": true
///     }
/// });
///
/// let header_json = serde_json::to_value(header).unwrap();
///
/// assert_eq!(header_json, expected);
/// ```
#[derive(Debug, Clone, Serialize)]
pub struct Header {
    #[serde(rename = "type")]
    kind: &'static str,

    text: Text,

    #[serde(skip_serializing_if = "Option::is_none")]
    block_id: Option<String>,
}

impl Default for Header {
    fn default() -> Self {
        Self {
            kind: "header",
            text: Text::plain(""),
            block_id: None,
        }
    }
}

impl Header {
    /// Constructs a Header block.
    ///
    /// ```
    /// use slack_messaging::blocks::Header;
    /// use serde_json::json;
    ///
    /// let header = Header::new();
    ///
    /// let expected = json!({
    ///     "type": "header",
    ///     "text": {
    ///         "type": "plain_text",
    ///         "text": "",
    ///         "emoji": true
    ///     }
    /// });
    ///
    /// let header_json = serde_json::to_value(header).unwrap();
    ///
    /// assert_eq!(header_json, expected);
    /// ```
    pub fn new() -> Self {
        Self::default()
    }

    /// Sets text field.
    ///
    /// ```
    /// use slack_messaging::blocks::Header;
    /// use slack_messaging::blocks::elements::Text;
    /// use serde_json::json;
    ///
    /// let header = Header::new()
    ///     .set_text(Text::plain("Budget Performance"));
    ///
    /// let expected = json!({
    ///     "type": "header",
    ///     "text": {
    ///         "type": "plain_text",
    ///         "text": "Budget Performance",
    ///         "emoji": true
    ///     }
    /// });
    ///
    /// let header_json = serde_json::to_value(header).unwrap();
    ///
    /// assert_eq!(header_json, expected);
    /// ```
    pub fn set_text(self, text: Text) -> Self {
        Self { text, ..self }
    }

    /// Sets text field from string. This is a shorthand for `set_text` method.
    ///
    /// ```
    /// use slack_messaging::blocks::Header;
    /// use serde_json::json;
    ///
    /// let header = Header::new().text("Budget Performance");
    ///
    /// let expected = json!({
    ///     "type": "header",
    ///     "text": {
    ///         "type": "plain_text",
    ///         "text": "Budget Performance",
    ///         "emoji": true
    ///     }
    /// });
    ///
    /// let header_json = serde_json::to_value(header).unwrap();
    ///
    /// assert_eq!(header_json, expected);
    /// ```
    pub fn text<T: Into<String>>(self, text: T) -> Self {
        self.set_text(Text::plain(text))
    }

    /// Sets block_id field.
    ///
    /// ```
    /// use slack_messaging::blocks::Header;
    /// use serde_json::json;
    ///
    /// let header = Header::new()
    ///     .set_block_id("header_1");
    ///
    /// let expected = json!({
    ///     "type": "header",
    ///     "block_id": "header_1",
    ///     "text": {
    ///         "type": "plain_text",
    ///         "text": "",
    ///         "emoji": true
    ///     }
    /// });
    ///
    /// let header_json = serde_json::to_value(header).unwrap();
    ///
    /// assert_eq!(header_json, expected);
    /// ```
    pub fn set_block_id<T: Into<String>>(self, block_id: T) -> Self {
        Self {
            block_id: Some(block_id.into()),
            ..self
        }
    }
}