Struct Image 

pub struct Image { /* private fields */ }

Image block representation.

Fields and Validations

For more details, see the official documentation.

Field	Type	Required	Validation
alt_text	String	Yes	Maximum 2000 characters
image_url	String	Conditional*	Maximum 3000 characters
title	Text<Plain>	No	Maximum 2000 characters
block_id	String	No	Maximum 255 characters
slack_file	SlackFile	Conditional*	N/A

Validation Across Fields

• Either image_url or slack_file is required. Both fields cannot be set simultaneously.

Example

use slack_messaging::plain_text;
use slack_messaging::blocks::Image;

let image = Image::builder()
    .block_id("image4")
    .title(plain_text!("Please enjoy this photo of a kitten")?)
    .image_url("http://placekitten.com/500/500")
    .alt_text("An incredibly cute kitten.")
    .build()?;

let expected = serde_json::json!({
    "type": "image",
    "block_id": "image4",
    "title": {
        "type": "plain_text",
        "text": "Please enjoy this photo of a kitten"
    },
    "image_url": "http://placekitten.com/500/500",
    "alt_text": "An incredibly cute kitten."
});

let json = serde_json::to_value(image).unwrap();

assert_eq!(json, expected);

Implementations

impl Image

pub fn builder() -> ImageBuilder

constract ImageBuilder object.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl From<Image> for Block

fn from(value: Image) -> Self

Converts to this type from the input type.

impl PartialEq for Image

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Image

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 Image