Struct slack_blocks::blocks::context::Contents [−][src]
pub struct Contents { /* fields omitted */ }
Implementations
impl Contents
[src]
impl Contents
[src]pub fn new() -> Self
[src]
pub fn new() -> Self
[src]Create an empty Context block (shorthand for Default::default()
)
Example
use slack_blocks::blocks::{Block, context}; use slack_blocks::text; let context = context::Contents::new() .with_element(text::Plain::from("my unformatted text")); let block: Block = context.into(); // < send block to slack's API >
pub fn with_block_id(self, block_id: impl ToString) -> Self
[src]
pub fn with_block_id(self, block_id: impl ToString) -> Self
[src]Set the block_id
for interactions on an existing context::Contents
Arguments
block_id
- A string acting as a unique identifier for a block. You can use thisblock_id
when you receive an interaction payload to identify the source of the action 🔗. If not specified, ablock_id
will be generated. Maximum length for this field is 255 characters.
Example
use slack_blocks::blocks::{Block, context}; use slack_blocks::text; let text = text::Mrkdwn::from("_flavor_ *text*"); let context: Block = context::Contents::new() .with_element(text) .with_block_id("msg_id_12346") .into(); // < send block to slack's API >
pub fn with_element(self, element: impl Into<Compose>) -> Self
[src]
pub fn with_element(self, element: impl Into<Compose>) -> Self
[src]Add a composition object to a context block.
This is chainable, and can be used to easily
populate the elements of a context block
right after invoking new
.
Arguments
element
- A composition object; Must be image elements or text objects. Maximum number of items is 10.
Example
use slack_blocks::blocks::{Block, context}; use slack_blocks::text; let context = context::Contents::new() .with_element(text::Plain::from("my unformatted text")); let block: Block = context.into(); // < send block to slack's API >
pub fn from_context_elements(
elements: impl IntoIterator<Item = impl Into<Compose>>
) -> Self
[src]
pub fn from_context_elements(
elements: impl IntoIterator<Item = impl Into<Compose>>
) -> Self
[src]Construct a new context::Contents
from a collection of
composition objects that are may not be supported by Context
Blocks.
If you can’t guarantee that a collection only contains image
or text objects, from_elements
may be more ergonomic for you.
Arguments
elements
- An array of composition objects; Must be image elements or text objects. Maximum number of items is 10.
Examples
use slack_blocks::blocks::{Block, context}; use slack_blocks::text; pub fn main() { let objs: Vec<text::Mrkdwn> = vec![ text::Mrkdwn::from("*s i c k*"), text::Mrkdwn::from("*t i g h t*"), ]; let context = context::Contents::from_context_elements(objs); let block: Block = context.into(); // < send block to slack's API > }
pub fn validate(&self) -> Result<(), ValidationErrors>
[src]
pub fn validate(&self) -> Result<(), ValidationErrors>
[src]Validate that this Context block agrees with Slack’s model requirements
Errors
- If
with_block_id
was called with a block id longer than 255 chars - If
from_elements
,from_context_elements
, orwith_element
was called with more than 10 objects
Example
use slack_blocks::blocks; let long_string = std::iter::repeat(' ').take(256).collect::<String>(); let block = blocks::context ::Contents ::new() .with_block_id(long_string); assert_eq!(true, matches!(block.validate(), Err(_)));
Trait Implementations
impl<'de> Deserialize<'de> for Contents
[src]
impl<'de> Deserialize<'de> for Contents
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl StructuralPartialEq for Contents
[src]
Auto Trait Implementations
impl RefUnwindSafe for Contents
impl Send for Contents
impl Sync for Contents
impl Unpin for Contents
impl UnwindSafe for Contents
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,