Struct Opt 

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

Option object representation.

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

Type Parameters

• T: The type of text object used for the text and description fields. Defaults to Text<Plain>. Must implement the TextExt trait.
• P: A phantom type used to control the availability of the url field. Defaults to UrlUnavailable. Use UrlAvailable to include the url field.

Fields and Validations

For more details, see the official documentation.

Field	Type	Required	Validation
text	type parameter T bounds TextExt	Yes	Max length 75 characters
value	String	Yes	Max length 150 characters
description	type parameter T bounds TextExt	No	Max length 75 characters
url	String	No (only if type parameter P is UrlAvailable)	Max length 3000 characters

Example

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

let option: Opt = Opt::builder()
    .text(plain_text!("Maru")?)
    .value("maru")
    .build()?;

let expected = serde_json::json!({
    "text": {
        "type": "plain_text",
        "text": "Maru"
    },
    "value": "maru"
});

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

assert_eq!(json, expected);

// Using UrlAvailable to include the url field
let option_with_url = Opt::<Text<Plain>, UrlAvailable>::builder()
   .text(plain_text!("Maru")?)
   .value("maru")
   .url("https://example.com/maru")
   .build()?;

let expected_with_url = serde_json::json!({
   "text": {
       "type": "plain_text",
       "text": "Maru"
   },
   "value": "maru",
   "url": "https://example.com/maru"
});

let json_with_url = serde_json::to_value(option_with_url).unwrap();

assert_eq!(json_with_url, expected_with_url);

// If your object has any validation errors, the build method returns Result::Err
let option = Opt::<Text<Plain>>::builder()
    .text(plain_text!("Maru")?)
    .build();

assert!(option.is_err());

Implementations

impl<T, P> Opt<T, P>

where T: TextExt,

pub fn builder() -> OptBuilder<T, P>

constract OptBuilder object.

Trait Implementations

impl<T, P: Clone> Clone for Opt<T, P>

where T: TextExt + Clone,

fn clone(&self) -> Opt<T, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, P: Debug> Debug for Opt<T, P>

where T: TextExt + Debug,

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

Formats the value using the given formatter.

impl<T, P: PartialEq> PartialEq for Opt<T, P>

where T: TextExt + PartialEq,

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

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, P> StructuralPartialEq for Opt<T, P>

where T: TextExt,