Struct Checkboxes 

pub struct Checkboxes<'a> { /* private fields */ }

Checkbox Group

A checkbox group that allows a user to choose multiple items from a list of possible options.

slack api docs 🔗

Works in blocks 🔗: Section, Actions, Input Works in app surfaces 🔗: Home tabs, Modals, Messages

Implementations

impl<'a> Checkboxes<'a>

pub fn builder() -> CheckboxesBuilderInit<'a>

Build a new checkboxes element.

Example

see example for build::CheckboxesBuilder.

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

Available on crate feature validation only.

Validate that this element agrees with Slack’s model requirements.

Errors

• length of action_id greater than 255
• length of options greater than 10
• length of initial_options greater than 10
• one or more of options is invalid // TODO
• one or more of initial_options is invalid // TODO
• initial_option is set and an invalid Opt
• confirm is set and an invalid Confirm

Example

use slack_blocks::{compose::Opt, elems::Checkboxes};

fn repeat<T: Copy>(el: T, n: usize) -> impl Iterator<Item = T> {
  std::iter::repeat(el).take(n)
}

let long_string: String = repeat('a', 256).collect();
let opt = Opt::builder().text_md("foo").value("bar").build();

let opts = repeat(&opt, 11).map(|o| o.clone()).collect::<Vec<_>>();

let input = Checkboxes::builder().action_id(long_string)
                                 .options(opts)
                                 .build();

assert!(matches!(input.validate(), Err(_)))

Trait Implementations

impl<'a> Clone for Checkboxes<'a>

fn clone(&self) -> Checkboxes<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Checkboxes<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Checkboxes<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<Checkboxes<'a>> for BlockElement<'a>

fn from(src: Checkboxes<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Checkboxes<'a>> for SupportedElement<'a>

fn from(src: Checkboxes<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Checkboxes<'a>> for SupportedElement<'a>

fn from(src: Checkboxes<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for Checkboxes<'a>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Checkboxes<'a>

fn eq(&self, other: &Checkboxes<'a>) -> 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<'a> Serialize for Checkboxes<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Validate for Checkboxes<'a>

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

impl<'a> StructuralPartialEq for Checkboxes<'a>