Text

Struct Text 

Source
pub struct Text<T> { /* private fields */ }
Expand description

Text object representation.

This is a generic struct that can represent either a plain text object or a markdown text object, depending on the type parameter T.

§Type Parameters

  • T: The type of text object. It can be either Plain for plain text or Mrkdwn for markdown text.

§Fields and Validations

For more details, see the Slack API documentation.

§Text<Plain>

FieldTypeRequiredValidation
textStringYesMinimum length: 1 character, Maximum length: 3000 characters.
emojiboolNoN/A

§Text<Mrkdwn>

FieldTypeRequiredValidation
textStringYesMinimum length: 1 character, Maximum length: 3000 characters.
verbatimboolNoN/A

§Example

 use slack_messaging::composition_objects::{Text, Plain, Mrkdwn};

 // 1. Plain Text Object
 let plain_text = Text::<Plain>::builder()
     .text("Hello, World!")
     .emoji(true)
     .build()?;

 let plain_json = serde_json::to_value(plain_text).unwrap();

 let expected_plain = serde_json::json!({
     "type": "plain_text",
     "text": "Hello, World!",
     "emoji": true
 });

 assert_eq!(plain_json, expected_plain);

 // 2. Markdown Text Object
 let mrkdwn_text = Text::<Mrkdwn>::builder()
     .text("*Hello*, _World_!")
     .verbatim(false)
     .build()?;

 let mrkdwn_json = serde_json::to_value(mrkdwn_text).unwrap();

 let expected_mrkdwn = serde_json::json!({
     "type": "mrkdwn",
     "text": "*Hello*, _World_!",
     "verbatim": false
 });

 assert_eq!(mrkdwn_json, expected_mrkdwn);

Implementations§

Source§

impl<T> Text<T>

Source

pub fn builder() -> TextBuilder<T>

constract TextBuilder object.

Trait Implementations§

Source§

impl<T: Clone> Clone for Text<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Text<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Text<Mrkdwn>> for TextContent

Source§

fn from(text: Text<Mrkdwn>) -> Self

Converts to this type from the input type.
Source§

impl From<Text<Plain>> for TextContent

Source§

fn from(text: Text<Plain>) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Text<Mrkdwn>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq for Text<Plain>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Text<Mrkdwn>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Serialize for Text<Plain>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<T> TextExt for Text<T>

Source§

fn text(&self) -> Option<&str>

get text field value.

Auto Trait Implementations§

§

impl<T> Freeze for Text<T>

§

impl<T> RefUnwindSafe for Text<T>
where T: RefUnwindSafe,

§

impl<T> Send for Text<T>
where T: Send,

§

impl<T> Sync for Text<T>
where T: Sync,

§

impl<T> Unpin for Text<T>
where T: Unpin,

§

impl<T> UnwindSafe for Text<T>
where T: UnwindSafe,

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.