Struct OptGroup 

pub struct OptGroup<T = Text<Plain>>
where
    T: TextExt,
{ /* private fields */ }

Option group object representation.

This is a generic struct that can represent an option group object with different text object types.

Type Parameters

• T: The type of text object used for the text field of the Opt objects in the options field. Defaults to Text<Plain>. Must implement the TextExt trait.

Fields and Validations

For more details, see the official documentation.

Field	Type	Required	Validation
label	Text<Plain>	Yes	Max length 75 characters
options	Vec<Opt<T>>	Yes	Must contain at most 100 items

Example

use slack_messaging::plain_text;
use slack_messaging::composition_objects::{OptGroup, Opt, Plain, Text};

let options: OptGroup = OptGroup::builder()
    .label(plain_text!("Group One")?)
    .option(
        Opt::builder()
            .text(plain_text!("option-0")?)
            .value("value-0")
            .build()?
    )
    .option(
        Opt::builder()
            .text(plain_text!("option-1")?)
            .value("value-1")
            .build()?
    )
    .build()?;

let expected = serde_json::json!({
    "label": {
        "type": "plain_text",
        "text": "Group One"
    },
    "options": [
        {
            "text": {
                "type": "plain_text",
                "text": "option-0",
            },
            "value": "value-0"
        },
        {
            "text": {
                "type": "plain_text",
                "text": "option-1"
            },
            "value": "value-1"
        },
    ]
});

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

assert_eq!(json, expected);

// If your object has any validation errors, the build method returns Result::Err
let options = OptGroup::<Text<Plain>>::builder()
    .label(plain_text!("Group One")?)
    .build();

assert!(options.is_err());

Implementations

impl<T> OptGroup<T>

where T: TextExt,

pub fn builder() -> OptGroupBuilder<T>

constract OptGroupBuilder object.

Trait Implementations

impl<T> Clone for OptGroup<T>

where T: TextExt + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for OptGroup<T>

where T: TextExt + Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq for OptGroup<T>

where T: TextExt + PartialEq,

fn eq(&self, other: &OptGroup<T>) -> 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<T> Serialize for OptGroup<T>

where T: TextExt + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for OptGroup<T>

where T: TextExt,