Struct slack_blocks::blocks::image::Contents

pub struct Contents { /* fields omitted */ }

Image Block

slack api docs 🔗

A simple image block, designed to make those cat photos really pop.

Implementations

impl Contents

pub fn from_alt_text_and_url(
    alt_text: impl ToString,
    image_url: impl ToString
) -> Self

Create an image block, with a url and a brief description for situations where the image cannot be rendered.

Arguments

• alt_text - A plain-text summary of the image. This should not contain any markup. Maximum length for this field is 2000 characters.

• image_url - The URL of the image to be displayed. Maximum length for this field is 3000 characters.

Example

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

let url = "https://www.cheese.com/favicon.ico";
let image: Block = image::Contents::from_alt_text_and_url("a small image of cheese.", url).into();

// < send to slack api >

pub fn with_title(self, title: impl Into<Plain>) -> Self

Set a plain-text title to be displayed next to your image

Arguments

• title - An optional title for the image in the form of a Plaintext text object 🔗. Maximum length for the text in this field is 2000 characters.

Example

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

let url = "https://www.cheese.com/favicon.ico";
let image: Block = image::Contents::from_alt_text_and_url("a small image of cheese.", url)
    .with_title("here is an image of some cheese:")
    .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 image::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, image};

let url = "https://www.cheese.com/favicon.ico";
let image: Block = image::Contents::from_alt_text_and_url("a small image of cheese.", url)
    .with_title("here is an image of some cheese:")
    .with_block_id("msg_id_12346")
    .into();

// < send block to slack's API >

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

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

Errors

• If with_block_id was called with a block id longer than 255 chars
• If with_title was called with a title longer than 2000 chars
• If from_url_and_alt_text was called with alt_text longer than 2000 chars
• If from_url_and_alt_text was called with image_url longer than 3000 chars

Example

use slack_blocks::blocks;

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

let block = blocks::image
    ::Contents
    ::from_alt_text_and_url("", "")
    .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 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>