Struct slack_blocks::blocks::context::Contents

pub struct Contents { /* fields omitted */ }

Context Block

slack api docs 🔗

Displays message context, which can include both images and text.

Implementations

impl Contents

pub fn new() -> Self

Create an empty Context block (shorthand for Default::default())

Example

use slack_blocks::blocks::{Block, context};
use slack_blocks::text;

let context = context::Contents::new()
    .with_element(text::Plain::from("my unformatted text"));

let block: Block = context.into();
// < send block to slack's API >

pub fn with_block_id(self, block_id: impl ToString) -> Self

Set the block_id for interactions on an existing context::Contents

Arguments

• block_id - A string acting as a unique identifier for a block. You can use this block_id when you receive an interaction payload to identify the source of the action 🔗. If not specified, a block_id will be generated. Maximum length for this field is 255 characters.

Example

use slack_blocks::blocks::{Block, context};
use slack_blocks::text;

let text = text::Mrkdwn::from("_flavor_ *text*");
let context: Block = context::Contents::new()
    .with_element(text)
    .with_block_id("msg_id_12346")
    .into();

// < send block to slack's API >

pub fn from_elements(
    elements: impl IntoIterator<Item = impl Into<Compose>>
) -> Result<Self, UnsupportedComposeError>

Construct a new context::Contents from a collection of composition objects that are definitely supported by Context Blocks.

If you can guarantee that a collection only contains image or text objects, from_context_elements may be more ergonomic for you.

Arguments

• elements - An array of composition objects; Must be image elements or text objects. Maximum number of items is 10.

Examples

use slack_blocks::blocks::{Block, context};
use slack_blocks::text;

let text = text::Mrkdwn::from("*s i c k*");
let context = context::Contents::from_elements(vec![text])?;
let block: Block = context.into();
// < send block to slack's API >

pub fn with_element(self, element: impl Into<Compose>) -> Self

Add a composition object to a context block.

This is chainable, and can be used to easily populate the elements of a context block right after invoking new.

Arguments

• element - A composition object; Must be image elements or text objects. Maximum number of items is 10.

Example

use slack_blocks::blocks::{Block, context};
use slack_blocks::text;

let context = context::Contents::new()
    .with_element(text::Plain::from("my unformatted text"));

let block: Block = context.into();
// < send block to slack's API >

pub fn from_context_elements(
    elements: impl IntoIterator<Item = impl Into<Compose>>
) -> Self

Construct a new context::Contents from a collection of composition objects that are may not be supported by Context Blocks.

If you can't guarantee that a collection only contains image or text objects, from_elements may be more ergonomic for you.

Arguments

• elements - An array of composition objects; Must be image elements or text objects. Maximum number of items is 10.

Examples

use slack_blocks::blocks::{Block, context};
use slack_blocks::text;

pub fn main() {
    let objs: Vec<text::Mrkdwn> = vec![
        text::Mrkdwn::from("*s i c k*"),
        text::Mrkdwn::from("*t i g h t*"),
    ];
    let context = context::Contents::from_context_elements(objs);
    let block: Block = context.into();
    // < send block to slack's API >
}

pub fn validate(&self) -> Result<(), ValidationErrors>

Validate that this Context block agrees with Slack's model requirements

Errors

• If with_block_id was called with a block id longer than 255 chars
• If from_elements, from_context_elements, or with_element was called with more than 10 objects

Example

use slack_blocks::blocks;

let long_string = std::iter::repeat(' ').take(256).collect::<String>();

let block = blocks::context
    ::Contents
    ::new()
    .with_block_id(long_string);

assert_eq!(true, matches!(block.validate(), Err(_)));

Trait Implementations

impl Clone for Contents

fn clone(&self) -> Contents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Contents

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

Formats the value using the given formatter.

impl Default for Contents

fn default() -> Contents

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Contents

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<Contents> for Block

fn from(contents: Contents) -> Self

Performs the conversion.

impl From<Vec<Compose>> for Contents

fn from(elements: Vec<Compose>) -> Self

Performs the conversion.

impl Hash for Contents

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Contents> for Contents

fn eq(&self, other: &Contents) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Contents) -> bool

This method tests for !=.

impl Serialize for Contents

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Contents

impl Validate for Contents

fn validate(&self) -> Result<(), ValidationErrors>