Struct ruma::events::room::message::UrlPreview

source ·

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

Available on crate feature events only.

Expand description

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

Fields§

§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§

source §

impl UrlPreview

source

pub fn matched_url(matched_url: String) -> UrlPreview

Construct an preview for a matched_url.

source

pub fn canonical_url(url: String) -> UrlPreview

Construct an preview for a canonical url.

source

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§

source §

impl Clone for UrlPreview

source §

fn clone(&self) -> UrlPreview

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

source §

impl Debug for UrlPreview

source §

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

Formats the value using the given formatter. Read more

source §

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

source §

fn deserialize<D>( deserializer: D, ) -> Result<UrlPreview, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source §

impl Serialize for UrlPreview

source §

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl UnwindSafe for UrlPreview

Blanket Implementations§

source §

impl<T> Any for T
where T: 'static + ?Sized,

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source §

impl<T> Borrow<T> for T
where T: ?Sized,

source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source §

impl<T> CloneToUninit for T
where T: Clone,

source §

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

source §

impl<T> From<T> for T

source §

fn from(t: T) -> T

Returns the argument unchanged.

source §

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source §

const WITNESS: W = W::MAKE

A constant of the type witness

source §

impl<T> Identity for T
where T: ?Sized,

source §

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.

source §

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).

source §

impl<T> Instrument for T

source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source §

impl<T, U> Into for T
where U: From<T>,

source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source §

impl<T> IntoEither for T

source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §