Struct BeaconInfoEventContent

#[non_exhaustive]
pub struct BeaconInfoEventContent {
    pub description: Option<String>,
    pub live: bool,
    pub ts: MilliSecondsSinceUnixEpoch,
    pub timeout: Duration,
    pub asset: AssetContent,
}

Available on crate feature unstable-msc3489 only.

The content of a beacon_info state.

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.

description: Option<String>

The description of the location.

It should be used to label the location on a map.

live: bool

Whether the user starts sharing their location.

ts: MilliSecondsSinceUnixEpoch

The time when location sharing started.

timeout: Duration

The duration that the location sharing will be live.

Meaning that the location will stop being shared at ts + timeout.

asset: AssetContent

The asset that this message refers to.

Implementations

impl BeaconInfoEventContent

pub fn new( description: Option<String>, timeout: Duration, live: bool, ts: Option<MilliSecondsSinceUnixEpoch>, ) -> BeaconInfoEventContent

Creates a new BeaconInfoEventContent with the given description, live, timeout and optional ts. If ts is None, the current time will be used.

pub fn start(&mut self)

Starts the beacon_info being live.

pub fn stop(&mut self)

Stops the beacon_info from being live.

pub fn is_live(&self) -> bool

Start time plus its timeout, it returns false, indicating that the beacon is not live. Otherwise, it returns true.

Trait Implementations

impl Clone for BeaconInfoEventContent

fn clone(&self) -> BeaconInfoEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BeaconInfoEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BeaconInfoEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for BeaconInfoEventContent

type EventType = StateEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> <BeaconInfoEventContent as EventContent>::EventType

Get the event’s type, like m.room.message.

impl From<BeaconInfoEventContent> for AnyStateEventContent

fn from(c: BeaconInfoEventContent) -> AnyStateEventContent

Converts to this type from the input type.

impl RedactContent for BeaconInfoEventContent

type Redacted = RedactedBeaconInfoEventContent

The redacted form of the event’s content.

fn redact(self, version: &RoomVersionId) -> RedactedBeaconInfoEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for BeaconInfoEventContent

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.

impl StateEventContent for BeaconInfoEventContent

type StateKey = OwnedUserId

The type of the event’s state_key field.

impl StaticEventContent for BeaconInfoEventContent

const TYPE: &'static str = "org.matrix.msc3672.beacon_info"

The event type.

impl StaticStateEventContent for BeaconInfoEventContent

type PossiblyRedacted = PossiblyRedactedBeaconInfoEventContent

The possibly redacted form of the event’s content.

type Unsigned = StateUnsigned<<BeaconInfoEventContent as StaticStateEventContent>::PossiblyRedacted>

The type of the event’s unsigned field.