Struct slack_blocks::compose::opt_group::OptGroup

pub struct OptGroup<M = ()> { /* fields omitted */ }

Option Group

slack api docs 🔗

Provides a way to group options in a select menu 🔗 or multi-select menu 🔗.

Implementations

impl OptGroup<()>

pub fn from_label_and_opts<M>(
    label: impl Into<Plain>,
    options: impl IntoIterator<Item = Opt<M>>
) -> OptGroup<M>

Construct an Option Group from a label and collection of options in the group

Arguments

• label - A plain_text only text object 🔗 that defines the label shown above this group of options. Maximum length for the text in this field is 75 characters.
• opts - An array of option objects 🔗 that belong to this specific group. Maximum of 100 items.

Example

use slack_blocks::blocks::Block;
use slack_blocks::blocks::section::Contents as Section;
use slack_blocks::blocks::actions::Contents as Actions;
use slack_blocks::text::{Mrkdwn};
use slack_blocks::compose::{OptGroup, Opt};

let prompt = "Choose your favorite city from each state!";

let blocks: Vec<Block> = vec![
    Section::from_text(Mrkdwn::from(prompt)).into(),
    // TODO: insert option group once block elements are in place
    Actions::from_action_elements(vec![]).into(),
];

let groups: Vec<OptGroup<_>> = vec![
    OptGroup::from_label_and_opts(
        "Arizona",
        vec![
            Opt::from_mrkdwn_and_value("Phoenix", "az_phx"),
            // etc...
        ]
    ),
    OptGroup::from_label_and_opts(
        "California",
        vec![
            Opt::from_mrkdwn_and_value("San Diego", "ca_sd"),
            // etc...
        ]
    ),
];

impl<M> OptGroup<M>

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

Validate that this Option Group object agrees with Slack's model requirements

Errors

• If from_label_and_opts was called with label longer than 75 chars
• If from_label_and_opts was called with more than 100 options

Example

use slack_blocks::compose::{OptGroup, Opt};
use std::iter::repeat;

let long_string: String = repeat(' ').take(76).collect();

let opt = Opt::from_mrkdwn_and_value("San Diego", "ca_sd");
let grp = OptGroup::from_label_and_opts(long_string, vec![opt]);

assert_eq!(true, matches!(grp.validate(), Err(_)));

Trait Implementations

impl<M: Clone> Clone for OptGroup<M>

fn clone(&self) -> OptGroup<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for OptGroup<M>

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

Formats the value using the given formatter.

impl<'de, M> Deserialize<'de> for OptGroup<M> where
    M: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<M: Hash> Hash for OptGroup<M>

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, 

Feeds a slice of this type into the given [Hasher].

impl<M: PartialEq> PartialEq<OptGroup<M>> for OptGroup<M>

fn eq(&self, other: &OptGroup<M>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OptGroup<M>) -> bool

This method tests for !=.

impl<M> Serialize for OptGroup<M> where
    M: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<M> StructuralPartialEq for OptGroup<M>

impl<M> Validate for OptGroup<M>

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