Struct slack_blocks::blocks::file::Contents

pub struct Contents { /* fields omitted */ }

File Block

slack api docs 🔗

Displays a remote file 🔗

Implementations

impl Contents

pub fn from_external_id(external_file_id: impl AsRef<str>) -> Self

Create a file block from a remote file 🔗's external ID.

Arguments

• external_file_id - The external unique ID for this file, which notably is an ID in slack's system that is a reference or hyperlink to your original resource, which is hosted outside of Slack. Slack does not support uploading files to send in a block at this time.

Example

use slack_blocks::blocks;
use slack_blocks::compose;

let file_id = upload_file_to_slack("https://www.cheese.com/cheese-wheel.png");

let block = blocks::file::Contents::from_external_id(file_id);

// < send to slack API >

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

Set a unique block_id to identify this instance of an File Block.

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, one will be generated. Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id.

example

use slack_blocks::blocks;
use slack_blocks::compose;

let file_id = upload_file_to_slack("https://www.cheese.com/cheese-wheel.png");

let block = blocks::file::Contents::from_external_id(file_id)
    .with_block_id("my_file_in_a_block_1234");

// < send to slack API >

pub fn validate(&self) -> ValidationResult

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

Errors

• If with_block_id was called with a block id longer than 256 chars

Example

use slack_blocks::block_elements::select;
use slack_blocks::blocks;
use slack_blocks::compose;

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

let block = blocks::file
    ::Contents
    ::from_external_id("file_id")
    .with_block_id(long_string);

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

// < send to slack API >

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<'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 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>