Struct LocationMessageEventContent

#[non_exhaustive]
pub struct LocationMessageEventContent {
    pub body: String,
    pub geo_uri: String,
    pub info: Option<Box<LocationInfo>>,
    pub message: Option<TextContentBlock>,
    pub location: Option<LocationContent>,
    pub asset: Option<AssetContent>,
    pub ts: Option<MilliSecondsSinceUnixEpoch>,
}

Available on crate feature events only.

The payload for a location message.

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.

body: String

A description of the location e.g. “Big Ben, London, UK”, or some kind of content description for accessibility, e.g. “location attachment”.

geo_uri: String

A geo URI representing the location.

info: Option<Box<LocationInfo>>

Info about the location being represented.

message: Option<TextContentBlock>

Available on crate feature unstable-msc3488 only.

Extensible-event text representation of the message.

If present, this should be preferred over the body field.

location: Option<LocationContent>

Available on crate feature unstable-msc3488 only.

Extensible-event location info of the message.

If present, this should be preferred over the geo_uri field.

asset: Option<AssetContent>

Available on crate feature unstable-msc3488 only.

Extensible-event asset this message refers to.

ts: Option<MilliSecondsSinceUnixEpoch>

Available on crate feature unstable-msc3488 only.

Extensible-event timestamp this message refers to.

Implementations

impl LocationMessageEventContent

pub fn new(body: String, geo_uri: String) -> LocationMessageEventContent

Creates a new LocationMessageEventContent with the given body and geo URI.

pub fn with_asset_type(self, asset: AssetType) -> LocationMessageEventContent

Available on crate feature unstable-msc3488 only.

Set the asset type of this LocationMessageEventContent.

pub fn with_ts( self, ts: MilliSecondsSinceUnixEpoch, ) -> LocationMessageEventContent

Available on crate feature unstable-msc3488 only.

Set the timestamp of this LocationMessageEventContent.

pub fn geo_uri(&self) -> &str

Get the geo: URI of this LocationMessageEventContent.

pub fn plain_text_representation(&self) -> &str

Get the plain text representation of this LocationMessageEventContent.

pub fn asset_type(&self) -> AssetType

Available on crate feature unstable-msc3488 only.

Get the asset type of this LocationMessageEventContent.

Trait Implementations

impl Clone for LocationMessageEventContent

fn clone(&self) -> LocationMessageEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocationMessageEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LocationMessageEventContent

fn deserialize<__D>( __deserializer: __D, ) -> Result<LocationMessageEventContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<LocationMessageEventContentSerDeHelper> for LocationMessageEventContent

fn from( value: LocationMessageEventContentSerDeHelper, ) -> LocationMessageEventContent

Converts to this type from the input type.

impl Serialize for LocationMessageEventContent

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.