Struct slack_messaging::blocks::Header

pub struct Header { /* private fields */ }

Header block 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);

Implementations

impl Header

pub fn new() -> Self

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 set_text(self, text: Text) -> Self

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 text<T: Into<String>>(self, text: T) -> 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 set_block_id<T: Into<String>>(self, block_id: T) -> Self

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);

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Header

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.

impl From<Header> for Block

fn from(value: Header) -> Self

Converts to this type from the input type.

impl Serialize for Header

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.