#[non_exhaustive]pub struct ImageMessageEventContent {
pub body: String,
pub formatted: Option<FormattedBody>,
pub filename: Option<String>,
pub source: MediaSource,
pub info: Option<Box<ImageInfo>>,
}
Expand description
The payload for an image message.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.body: String
A textual representation of the image.
If the filename
field is not set or has the same value, this is the filename of the
uploaded file. Otherwise, this should be interpreted as a user-written media caption.
formatted: Option<FormattedBody>
Formatted form of the message body
.
This should only be set if the body represents a caption.
filename: Option<String>
The original filename of the uploaded file as deserialized from the event.
It is recommended to use the filename
method to get the filename which automatically
falls back to the body
field when the filename
field is not set.
source: MediaSource
The source of the image.
info: Option<Box<ImageInfo>>
Metadata about the image referred to in source
.
Implementations§
source§impl ImageMessageEventContent
impl ImageMessageEventContent
sourcepub fn new(body: String, source: MediaSource) -> ImageMessageEventContent
pub fn new(body: String, source: MediaSource) -> ImageMessageEventContent
Creates a new ImageMessageEventContent
with the given body and source.
sourcepub fn plain(body: String, url: OwnedMxcUri) -> ImageMessageEventContent
pub fn plain(body: String, url: OwnedMxcUri) -> ImageMessageEventContent
Creates a new non-encrypted ImageMessageEventContent
with the given body and url.
sourcepub fn encrypted(body: String, file: EncryptedFile) -> ImageMessageEventContent
pub fn encrypted(body: String, file: EncryptedFile) -> ImageMessageEventContent
Creates a new encrypted ImageMessageEventContent
with the given body and encrypted
file.
sourcepub fn info(
self,
info: impl Into<Option<Box<ImageInfo>>>,
) -> ImageMessageEventContent
pub fn info( self, info: impl Into<Option<Box<ImageInfo>>>, ) -> ImageMessageEventContent
Creates a new ImageMessageEventContent
from self
with the info
field set to the given
value.
Since the field is public, you can also assign to it directly. This method merely acts as a shorthand for that, because it is very common to set this field.
sourcepub fn filename(&self) -> &str
pub fn filename(&self) -> &str
Computes the filename of the image as defined by the spec.
This differs from the filename
field as this method falls back to the body
field when
the filename
field is not set.
Returns the caption for the image as defined by the spec.
In short, this is the body
field if the filename
field exists and has a different value,
otherwise the media file does not have a caption.
Returns the formatted caption for the image as defined by the spec.
This is the same as caption
, but returns the formatted body instead of the plain body.
Trait Implementations§
source§impl Clone for ImageMessageEventContent
impl Clone for ImageMessageEventContent
source§fn clone(&self) -> ImageMessageEventContent
fn clone(&self) -> ImageMessageEventContent
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ImageMessageEventContent
impl Debug for ImageMessageEventContent
source§impl<'de> Deserialize<'de> for ImageMessageEventContent
impl<'de> Deserialize<'de> for ImageMessageEventContent
source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<ImageMessageEventContent, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<ImageMessageEventContent, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
source§impl Serialize for ImageMessageEventContent
impl Serialize for ImageMessageEventContent
source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Auto Trait Implementations§
impl Freeze for ImageMessageEventContent
impl RefUnwindSafe for ImageMessageEventContent
impl Send for ImageMessageEventContent
impl Sync for ImageMessageEventContent
impl Unpin for ImageMessageEventContent
impl UnwindSafe for ImageMessageEventContent
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)