Skip to main content

Carousel

Struct Carousel 

Source
pub struct Carousel { /* private fields */ }
Expand description

Carousel block representation

§Fields and Validations

For more details, see the official documentation.

FieldTypeRequiredValidation
elementsVec<Card>YesMust contain as least 1 card and at most 10 cards.
block_idStringNoMust be 255 characters or less.

§Examples

use slack_messaging::{plain_text, mrkdwn};
use slack_messaging::blocks::{Card, Carousel};
use slack_messaging::blocks::elements::{Button, Image};

let carousel = Carousel::builder()
    .element(
        Card::builder()
            .block_id("carousel-card-1")
            .icon(
                Image::builder()
                    .image_url("https://picsum.photos/36/36")
                    .alt_text("Icon")
                    .build()?
            )
            .title(mrkdwn!("MDR")?)
            .subtitle(mrkdwn!("Refining data files")?)
            .hero_image(
                Image::builder()
                    .image_url("https://picsum.photos/400/300")
                    .alt_text("Sample hero image")
                    .build()?
            )
            .body(mrkdwn!("Blue badge required to gain access.")?)
            .action(
                Button::builder()
                    .text(plain_text!("Action Button")?)
                    .action_id("button_action_1")
                    .build()?
            )
            .build()?
    )
    .element(
        Card::builder()
            .block_id("carousel-card-2")
            .icon(
                Image::builder()
                    .image_url("https://picsum.photos/36/36")
                    .alt_text("Icon")
                    .build()?
            )
            .title(mrkdwn!("O&D")?)
            .subtitle(mrkdwn!("Storage, maintenance, and rotation of art pieces")?)
            .hero_image(
                Image::builder()
                    .image_url("https://picsum.photos/400/300")
                    .alt_text("Sample hero image")
                    .build()?
            )
            .body(mrkdwn!("Green badge required to gain access.")?)
            .action(
                Button::builder()
                    .text(plain_text!("Action Button")?)
                    .action_id("button_action_2")
                    .build()?
            )
            .build()?
    )
    .element(
        Card::builder()
            .block_id("carousel-card-3")
            .icon(
                Image::builder()
                    .image_url("https://picsum.photos/36/36")
                    .alt_text("Icon")
                    .build()?
            )
            .title(mrkdwn!("Wellness Center")?)
            .subtitle(mrkdwn!("Wellness sessions")?)
            .hero_image(
                Image::builder()
                    .image_url("https://picsum.photos/400/300")
                    .alt_text("Sample hero image")
                    .build()?
            )
            .body(mrkdwn!("Please take a seat in the waiting room until called.")?)
            .action(
                Button::builder()
                    .text(plain_text!("Action Button")?)
                    .action_id("button_action_3")
                    .build()?
            )
            .build()?
    )
    .build()?;

let expected = serde_json::json!({
    "type": "carousel",
    "elements": [
        {
            "type": "card",
            "block_id": "carousel-card-1",
            "icon": {
                "type": "image",
                "image_url": "https://picsum.photos/36/36",
                "alt_text": "Icon"
            },
            "title": {
                "type": "mrkdwn",
                "text": "MDR"
            },
            "subtitle": {
                "type": "mrkdwn",
                "text": "Refining data files"
            },
            "hero_image": {
                "type": "image",
                "image_url": "https://picsum.photos/400/300",
                "alt_text": "Sample hero image"
            },
            "body": {
                "type": "mrkdwn",
                "text": "Blue badge required to gain access."
            },
            "actions": [
                {
                    "type": "button",
                    "text": {
                        "type": "plain_text",
                        "text": "Action Button"
                    },
                    "action_id": "button_action_1"
                }
            ]
        },
        {
            "type": "card",
            "block_id": "carousel-card-2",
            "icon": {
                "type": "image",
                "image_url": "https://picsum.photos/36/36",
                "alt_text": "Icon"
            },
            "title": {
                "type": "mrkdwn",
                "text": "O&D"
            },
            "subtitle": {
                "type": "mrkdwn",
                "text": "Storage, maintenance, and rotation of art pieces"
            },
            "hero_image": {
                "type": "image",
                "image_url": "https://picsum.photos/400/300",
                "alt_text": "Sample hero image"
            },
            "body": {
                "type": "mrkdwn",
                "text": "Green badge required to gain access."
            },
            "actions": [
                {
                    "type": "button",
                    "text": {
                        "type": "plain_text",
                        "text": "Action Button"
                    },
                    "action_id": "button_action_2"
                }
            ]
        },
        {
            "type": "card",
            "block_id": "carousel-card-3",
            "icon": {
                "type": "image",
                "image_url": "https://picsum.photos/36/36",
                "alt_text": "Icon"
            },
            "title": {
                "type": "mrkdwn",
                "text": "Wellness Center"
            },
            "subtitle": {
                "type": "mrkdwn",
                "text": "Wellness sessions"
            },
            "hero_image": {
                "type": "image",
                "image_url": "https://picsum.photos/400/300",
                "alt_text": "Sample hero image"
            },
            "body": {
                "type": "mrkdwn",
                "text": "Please take a seat in the waiting room until called."
            },
            "actions": [
                {
                    "type": "button",
                    "text": {
                        "type": "plain_text",
                        "text": "Action Button"
                    },
                    "action_id": "button_action_3"
                }
            ]
        }
    ]
});

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

assert_eq!(json, expected);

Implementations§

Trait Implementations§

Source§

fn clone(&self) -> Carousel

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Carousel> for Block

Source§

fn from(value: Carousel) -> Self

Converts to this type from the input type.
Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.