Struct slack_blocks::blocks::actions::Contents

pub struct Contents { /* fields omitted */ }

Actions Block

[slack api docs 🔗][action_docs]

A block that is used to hold interactive elements 🔗

Implementations

impl Contents

pub fn new() -> Self

Create an empty Actions block (uses Default)

pub fn with_block_id<StrIsh: AsRef<str>>(self, block_id: StrIsh) -> Self

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

use slack_blocks::blocks::{Block, actions};

pub fn main() {
    let actions = actions::Contents::new().with_block_id("tally_ho");
    let block: Block = actions.into();
    // < send block to slack's API >
}

pub fn from_elements<Els: Into<Vec<BlockElement>>>(
    elements: Els
) -> Result<Self, ()>

Populate an Actions block with a collection of BlockElements that may not be supported by Actions blocks.

For an infallible version of this conversion function, see from_action_elements.

Errors

Errors if the block_elements::BlockElement is one that is not supported by Actions blocks.

For a list of BlockElement types that are, see self::BlockElement.

Runtime Validation

only validates that the block elements are compatible with Actions, for full runtime model validation see the validate method.

use slack_blocks::blocks::{Block, actions};
use slack_blocks::compose;
use slack_blocks::block_elements;

pub fn main() -> Result<(), ()> {
    let btn = block_elements::BlockElement::Button;
    let actions = actions::Contents::from_elements(vec![btn])?;
    let block: Block = actions.into();
    // < send block to slack's API >
    Ok(())
}

pub fn from_action_elements<Els: IntoIterator<Item = impl Into<BlockElement>>>(
    elements: Els
) -> Self

Populate an Actions block with a collection of BlockElements that are supported by Actions blocks.

For slightly easier to use (but fallible) version of this conversion function, see from_action_elements.

Runtime Validation

only validates that the block elements are compatible with Actions, for full runtime model validation see the validate method.

use slack_blocks::blocks::{Block, actions};
use slack_blocks::compose;
use slack_blocks::block_elements;

pub fn main() {
    let btn = actions::BlockElement::Button;
    let actions = actions::Contents::from_action_elements(vec![btn]);
    let block: Block = actions.into();
    // < send block to slack's API >
}

pub fn validate(&self) -> ValidationResult

Validate the entire block and all of its elements against Slack's model requirements

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<BlockElement>> for Contents

fn from(elements: Vec<BlockElement>) -> 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 TryFrom<Vec<BlockElement>> for Contents

type Error = ()

The type returned in the event of a conversion error.

fn try_from(elements: Vec<BlockElement>) -> Result<Self, Self::Error>

Performs the conversion.

impl Validate for Contents

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