Struct slack_blocks::blocks::image::build::ImageBuilder

pub struct ImageBuilder<'a, Url, Alt> { /* fields omitted */ }

Build an Image block

Allows you to construct safely, with compile-time checks on required setter methods.

Required Methods

ImageBuilder::build() is only available if these methods have been called:

• external_id
• source

Example

use slack_blocks::{blocks::Image, text::ToSlackPlaintext};

let block = Image::builder().image_url("https://foo.com/bar.png")
                            .alt_text("pic of bar")
                            .build();

Implementations

impl<'a, Url, Alt> ImageBuilder<'a, Url, Alt>

pub fn new() -> Self

Create a new ImageBuilder

pub fn title<T>(self, text: T) -> Self where
    T: Into<Plain>, 

Set title (Optional)

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.

pub fn src<S>(self, image_url: S) -> ImageBuilder<'a, Set<url>, Alt> where
    S: Into<Cow<'a, str>>, 

Alias for image_url.

pub fn image_url<S>(self, image_url: S) -> ImageBuilder<'a, Set<url>, Alt> where
    S: Into<Cow<'a, str>>, 

Set image_url (Required)

The URL of the image to be displayed.

Maximum length for this field is 3000 characters.

pub fn alt_text<S>(self, alt_text: S) -> ImageBuilder<'a, Url, Set<alt>> where
    S: Into<Cow<'a, str>>, 

Set alt_text (Required)

A plain-text summary of the image.

This should not contain any markup.

Maximum length for this field is 2000 characters.

pub fn alt<S>(self, alt_text: S) -> ImageBuilder<'a, Url, Set<alt>> where
    S: Into<Cow<'a, str>>, 

Alias for alt_text.

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

Set block_id (Optional)

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.

impl<'a> ImageBuilder<'a, Set<url>, Set<alt>>

pub fn build(self) -> Image<'a>

All done building, now give me a darn actions block!

no method name 'build' found for struct 'ImageBuilder<...>'? Make sure all required setter methods have been called. See docs for ImageBuilder.

use slack_blocks::blocks::Image;

let foo = Image::builder().build(); // Won't compile!

use slack_blocks::{blocks::Image, compose::text::ToSlackPlaintext};

let block = Image::builder().image_url("https://foo.com/bar.png")
                            .alt_text("pic of bar")
                            .build();

Trait Implementations

impl<'a, Url: Debug, Alt: Debug> Debug for ImageBuilder<'a, Url, Alt>

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

Formats the value using the given formatter.