Skip to main content

Card

Struct Card 

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

Card block representation.

§Fields and Validations

For more details, see the official documentation.

FieldTypeRequiredValidation
block_idStringNoMaximum 255 characters
hero_imageImageNoN/A
iconImageNoN/A
titleTextContentNoMaximum 150 characters
subtitleTextContentNoMaximum 150 characters
bodyTextContentNoMaximum 200 characters
actionsVec<Button>NoN/A

§Validation Across Fields

  • At least one of hero_image, title, actions, or body is required.

§Example

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

let card = Card::builder()
    .icon(
        Image::builder()
            .image_url("https://picsum.photos/36/36")
            .alt_text("Icon")
            .build()?
    )
    .title(mrkdwn!("Lumon Industries")?)
    .subtitle(mrkdwn!("Committed to work-life balance")?)
    .hero_image(
        Image::builder()
            .image_url("https://picsum.photos/400/300")
            .alt_text("Sample hero image")
            .build()?
    )
    .body(mrkdwn!("Please enjoy each card equally.")?)
    .action(
        Button::builder()
            .text(plain_text!("Action Button")?)
            .action_id("button_action")
            .build()?
    )
    .build()?;

let expected = serde_json::json!({
    "type": "card",
    "icon": {
        "type": "image",
        "image_url": "https://picsum.photos/36/36",
        "alt_text": "Icon"
    },
    "title": {
        "type": "mrkdwn",
        "text": "Lumon Industries"
    },
    "subtitle": {
        "type": "mrkdwn",
        "text": "Committed to work-life balance"
    },
    "hero_image": {
        "type": "image",
        "image_url": "https://picsum.photos/400/300",
        "alt_text": "Sample hero image"
    },
    "body": {
        "type": "mrkdwn",
        "text": "Please enjoy each card equally."
    },
    "actions": [
        {
            "type": "button",
            "text": {
                "type": "plain_text",
                "text": "Action Button"
            },
            "action_id": "button_action"
        }
    ]
});

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

assert_eq!(json, expected);

Implementations§

Source§

impl Card

Source

pub fn builder() -> CardBuilder

constract CardBuilder object.

Trait Implementations§

Source§

impl Clone for Card

Source§

fn clone(&self) -> Card

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§

impl Debug for Card

Source§

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

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

impl From<Card> for Block

Source§

fn from(value: Card) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Card

Source§

fn eq(&self, other: &Card) -> 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§

impl Serialize for Card

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
Source§

impl StructuralPartialEq for Card

Auto Trait Implementations§

§

impl Freeze for Card

§

impl RefUnwindSafe for Card

§

impl Send for Card

§

impl Sync for Card

§

impl Unpin for Card

§

impl UnsafeUnpin for Card

§

impl UnwindSafe for Card

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.