Struct slack_blocks::blocks::file::File

pub struct File<'a> { /* fields omitted */ }

File Block

slack api docs 🔗

Displays a remote file 🔗

Implementations

impl<'a> File<'a>

pub fn builder() -> FileBuilderInit<'a>

Build a new File block.

For example, see docs for FileBuilder.

pub fn from_external_id(external_file_id: impl Into<Cow<'a, str>>) -> Self

👎 Deprecated since 0.19.3:

use File::builder

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, compose};

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

let block = blocks::File::from_external_id(file_id);

// < send to slack API >

pub fn with_block_id(self, block_id: impl Into<Cow<'a, str>>) -> Self

👎 Deprecated since 0.19.3:

use File::builder

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, compose};

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

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

// < send to slack API >

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

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::{blocks, compose};

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

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

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

// < send to slack API >

Trait Implementations

impl<'a> Clone for File<'a>

fn clone(&self) -> File<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for File<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for File<'a>

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

Deserialize this value from the given Serde deserializer.

impl<'a> From<File<'a>> for Block<'a>

fn from(src: File<'a>) -> Self

Performs the conversion.

impl<'a> Hash for File<'a>

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<'a> PartialEq<File<'a>> for File<'a>

fn eq(&self, other: &File<'a>) -> bool

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

fn ne(&self, other: &File<'a>) -> bool

This method tests for !=.

impl<'a> Serialize for File<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> Validate for File<'a>

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

impl<'a> StructuralPartialEq for File<'a>