Struct slack_blocks::blocks::File [−][src]
pub struct File { /* fields omitted */ }
Expand description
Implementations
impl Contents
[src]
impl Contents
[src]pub fn from_external_id(external_file_id: impl AsRef<str>) -> Self
[src]
pub fn from_external_id(external_file_id: impl AsRef<str>) -> Self
[src]Create a file block from a remote file 🔗’s external ID.
Arguments
external_file_id
- The external unique ID for this file, which notably is an ID in slack’s system that is a reference or hyperlink to your original resource, which is hosted outside of Slack. Slack does not support uploading files to send in a block at this time.
Example
use slack_blocks::{blocks, compose}; let file_id = upload_file_to_slack("https://www.cheese.com/cheese-wheel.png"); let block = blocks::file::Contents::from_external_id(file_id); // < send to slack API >
pub fn with_block_id(self, block_id: impl AsRef<str>) -> Self
[src]
pub fn with_block_id(self, block_id: impl AsRef<str>) -> Self
[src]Set a unique block_id
to identify this instance of an File Block.
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, one will be generated. Maximum length for this field is 255 characters.block_id
should be unique for each message and each iteration of a message. If a message is updated, use a newblock_id
.
example
use slack_blocks::{blocks, compose}; let file_id = upload_file_to_slack("https://www.cheese.com/cheese-wheel.png"); let block = blocks::file::Contents::from_external_id(file_id) .with_block_id("my_file_in_a_block_1234"); // < send to slack API >
pub fn validate(&self) -> Result<(), ValidationErrors>
[src]
pub fn validate(&self) -> Result<(), ValidationErrors>
[src]Validate that this File block agrees with Slack’s model requirements
Errors
- If
with_block_id
was called with a block id longer than 256 chars
Example
use slack_blocks::{blocks, compose}; let long_string = std::iter::repeat(' ').take(256).collect::<String>(); let block = blocks::file ::Contents ::from_external_id("file_id") .with_block_id(long_string); assert_eq!(true, matches!(block.validate(), Err(_))); // < send to slack API >
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>,