ruma_events/room/message/
media_caption.rs

1//! Reusable methods for captioning media files.
2
3use crate::room::message::FormattedBody;
4
5/// Computes the caption of a media file as defined by the [spec](https://spec.matrix.org/latest/client-server-api/#media-captions).
6///
7/// In short, this is the `body` field if the `filename` field exists and has a different value,
8/// otherwise the media file does not have a caption.
9pub(crate) fn caption<'a>(body: &'a str, filename: Option<&str>) -> Option<&'a str> {
10    filename.is_some_and(|filename| body != filename).then_some(body)
11}
12
13/// Computes the formatted caption of a media file as defined by the [spec](https://spec.matrix.org/latest/client-server-api/#media-captions).
14///
15/// This is the same as `caption`, but returns the formatted body instead of the plain body.
16pub(crate) fn formatted_caption<'a>(
17    body: &str,
18    formatted: Option<&'a FormattedBody>,
19    filename: Option<&str>,
20) -> Option<&'a FormattedBody> {
21    filename.is_some_and(|filename| body != filename).then_some(formatted).flatten()
22}