Struct slack_blocks::blocks::Image [−][src]
pub struct Image<'a> { /* fields omitted */ }
Expand description
Implementations
impl<'a> Image<'a>
[src]
impl<'a> Image<'a>
[src]pub fn builder() -> ImageBuilderInit<'a>
[src]
pub fn builder() -> ImageBuilderInit<'a>
[src]Build a new Image block.
For example, see docs for ImageBuilder.
pub fn from_alt_text_and_url(
alt_text: impl Into<Cow<'a, str>>,
image_url: impl Into<Cow<'a, str>>
) -> Self
[src]
👎 Deprecated since 0.19.4: use Image::builder
pub fn from_alt_text_and_url(
alt_text: impl Into<Cow<'a, str>>,
image_url: impl Into<Cow<'a, str>>
) -> Self
[src]use Image::builder
Create an image block, with a url and a brief description for situations where the image cannot be rendered.
Arguments
-
alt_text
- A plain-text summary of the image. This should not contain any markup. Maximum length for this field is 2000 characters. -
image_url
- The URL of the image to be displayed. Maximum length for this field is 3000 characters.
Example
use slack_blocks::blocks::{Block, Image}; let url = "https://www.cheese.com/favicon.ico"; let image: Block = Image::from_alt_text_and_url("a small image of cheese.", url).into(); // < send to slack api >
pub fn with_title(self, title: impl Into<Plain>) -> Self
[src]
👎 Deprecated since 0.19.4: use Image::builder
pub fn with_title(self, title: impl Into<Plain>) -> Self
[src]use Image::builder
Set a plain-text title to be displayed next to your image
Arguments
- title - An optional title for the image in the form of a Plaintext text object 🔗. Maximum length for the text in this field is 2000 characters.
Example
use slack_blocks::blocks::{Block, Image}; let url = "https://www.cheese.com/favicon.ico"; let image: Block = Image::from_alt_text_and_url("a small image of cheese.", url) .with_title("here is an image of some cheese:") .into(); // < send block to slack's API >
pub fn with_block_id(self, block_id: impl Into<Cow<'a, str>>) -> Self
[src]
👎 Deprecated since 0.19.4: use Image::builder
pub fn with_block_id(self, block_id: impl Into<Cow<'a, str>>) -> Self
[src]use Image::builder
Set the block_id
for interactions on an existing Image
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, Image}; let url = "https://www.cheese.com/favicon.ico"; let image: Block = Image::from_alt_text_and_url("a small image of cheese.", url) .with_title("here is an image of some cheese:") .with_block_id("msg_id_12346") .into(); // < send block to slack's API >
pub fn validate(&self) -> Result<(), ValidationErrors>
[src]
pub fn validate(&self) -> Result<(), ValidationErrors>
[src]Validate that this Image block agrees with Slack’s model requirements
Errors
- If
with_block_id
was called with a block id longer than 255 chars - If
with_title
was called with a title longer than 2000 chars - If
from_url_and_alt_text
was called withalt_text
longer than 2000 chars - If
from_url_and_alt_text
was called withimage_url
longer than 3000 chars
Example
use slack_blocks::blocks; let long_string = std::iter::repeat(' ').take(256).collect::<String>(); let block = blocks::Image::from_alt_text_and_url("", "").with_block_id(long_string); assert_eq!(true, matches!(block.validate(), Err(_)));
Trait Implementations
impl<'de, 'a> Deserialize<'de> for Image<'a>
[src]
impl<'de, 'a> Deserialize<'de> for Image<'a>
[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<'a> StructuralPartialEq for Image<'a>
[src]
Auto Trait Implementations
impl<'a> RefUnwindSafe for Image<'a>
impl<'a> Send for Image<'a>
impl<'a> Sync for Image<'a>
impl<'a> Unpin for Image<'a>
impl<'a> UnwindSafe for Image<'a>
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>,