Struct slack_blocks::compose::Opt

pub struct Opt<'a, T = AnyText, U = NoUrl> { /* fields omitted */ }

Option Object

slack api docs 🔗

An object that represents a single selectable item in a

• select menu 🔗,
• multi-select menu 🔗,
• checkbox group 🔗,
• radio button group 🔗,
• or overflow menu 🔗.

Implementations

impl<'a> Opt<'a>

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

Build a new option composition object

Examples

use slack_blocks::{blocks::{Actions, Block},
                   compose::Opt,
                   elems::{select::Static, BlockElement},
                   text};

struct City {
  name: String,
  short_code: String,
}

impl City {
  pub fn new(name: impl ToString, short_code: impl ToString) -> Self {
    Self { name: name.to_string(),
           short_code: short_code.to_string() }
  }
}

let cities = vec![City::new("Seattle", "SEA"),
                  City::new("Portland", "PDX"),
                  City::new("Phoenix", "PHX")];

let options =
  cities.iter().map(|City { name, short_code }| {
                 Opt::builder().text_plain(name).value(short_code).build()
               });

let select = Static::builder().placeholder("Choose your favorite city!")
                              .action_id("fave_city")
                              .options(options)
                              .build();

let block: Block = Actions::builder().element(select).build().into();

impl<'a, T, U> Opt<'a, T, U>

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

This is supported on crate feature validation only.

Validate that this Option composition object agrees with Slack’s model requirements

Errors

• If text longer than 75 chars
• If value longer than 75 chars
• If url longer than 3000 chars
• If description longer than 75 chars

Example

use std::iter::repeat;

use slack_blocks::compose::Opt;

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

let opt = Opt::builder().text_plain("My Option")
                        .value(long_string)
                        .build();

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

Trait Implementations

impl<'a, Multi, Placeholder, ActionId> AppendOptOrOptGroup<'a, Multi, Placeholder, ActionId> for Opt<'a, Plain, NoUrl>

This is supported on crate feature blox only.

type Output = StaticBuilder<'a, Multi, Placeholder, ActionId, Set<(options, StaticOpt<'a>)>>

The builder state after adding the opt / opt group

fn add_to(
    self,
    builder: StaticBuilder<'a, Multi, Placeholder, ActionId, RequiredMethodNotCalled<options>>
) -> Self::Output

Add this opt / opt group to the builder

impl<'a, T: Clone, U: Clone> Clone for Opt<'a, T, U>

fn clone(&self) -> Opt<'a, T, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug, U: Debug> Debug for Opt<'a, T, U>

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

Formats the value using the given formatter.

impl<'de, 'a, T, U> Deserialize<'de> for Opt<'a, T, U>

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

Deserialize this value from the given Serde deserializer.

impl<'a, T: Into<Text>, U> From<Opt<'a, T, U>> for Opt<'a, AnyText, U>

fn from(o: Opt<'a, T, U>) -> Self

Performs the conversion.

impl<'a, T, U> From<Opt<'a, T, U>> for OptOrOptGroup<'a, T, U>

fn from(src: Opt<'a, T, U>) -> Self

Performs the conversion.

impl<'a, T: Hash, U: Hash> Hash for Opt<'a, T, U>

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<'a, T: PartialEq, U: PartialEq> PartialEq<Opt<'a, T, U>> for Opt<'a, T, U>

fn eq(&self, other: &Opt<'a, T, U>) -> bool

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

fn ne(&self, other: &Opt<'a, T, U>) -> bool

This method tests for !=.

impl<'a, T, U> Serialize for Opt<'a, T, U>

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

Serialize this value into the given Serde serializer.

impl<'a, T, U> Validate for Opt<'a, T, U>

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

impl<'a, T, U> StructuralPartialEq for Opt<'a, T, U>