Struct UrlPreview

#[non_exhaustive]
pub struct UrlPreview {
    pub matched_url: Option<String>,
    pub url: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub image: Option<PreviewImage>,
}

Preview Information for a URL matched in the message’s text, according to MSC 4095.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

matched_url: Option<String>

The url this was matching on.

url: Option<String>

Canonical URL according to open graph data.

title: Option<String>

Title to use for the preview.

description: Option<String>

Description to use for the preview.

image: Option<PreviewImage>

Metadata of a preview image if given.

Implementations

impl UrlPreview

pub fn matched_url(matched_url: String) -> Self

Construct an preview for a matched_url.

pub fn canonical_url(url: String) -> Self

Construct an preview for a canonical url.

pub fn contains_preview(&self) -> bool

Whether this preview contains an actual preview or the users homeserver should be asked for preview data instead.

Trait Implementations

impl Clone for UrlPreview

fn clone(&self) -> UrlPreview

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UrlPreview

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UrlPreview

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UrlPreview

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.