Struct ruma::events::beacon_info::BeaconInfoEventContent
source · #[non_exhaustive]pub struct BeaconInfoEventContent {
pub description: Option<String>,
pub live: bool,
pub ts: MilliSecondsSinceUnixEpoch,
pub timeout: Duration,
pub asset: AssetContent,
}
Expand description
The content of a beacon_info state.
Fields (Non-exhaustive)§
This struct is marked as 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§
source§impl BeaconInfoEventContent
impl BeaconInfoEventContent
sourcepub fn new(
description: Option<String>,
timeout: Duration,
live: bool,
ts: Option<MilliSecondsSinceUnixEpoch>,
) -> 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.
Trait Implementations§
source§impl Clone for BeaconInfoEventContent
impl Clone for BeaconInfoEventContent
source§fn clone(&self) -> BeaconInfoEventContent
fn clone(&self) -> BeaconInfoEventContent
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for BeaconInfoEventContent
impl Debug for BeaconInfoEventContent
source§impl<'de> Deserialize<'de> for BeaconInfoEventContent
impl<'de> Deserialize<'de> for BeaconInfoEventContent
source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<BeaconInfoEventContent, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<BeaconInfoEventContent, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl EventContent for BeaconInfoEventContent
impl EventContent for BeaconInfoEventContent
§type EventType = StateEventType
type EventType = StateEventType
The Rust enum for the event kind’s known types.
source§fn event_type(&self) -> <BeaconInfoEventContent as EventContent>::EventType
fn event_type(&self) -> <BeaconInfoEventContent as EventContent>::EventType
Get the event’s type, like
m.room.message
.source§impl From<BeaconInfoEventContent> for AnyStateEventContent
impl From<BeaconInfoEventContent> for AnyStateEventContent
source§fn from(c: BeaconInfoEventContent) -> AnyStateEventContent
fn from(c: BeaconInfoEventContent) -> AnyStateEventContent
Converts to this type from the input type.
source§impl RedactContent for BeaconInfoEventContent
impl RedactContent for BeaconInfoEventContent
§type Redacted = RedactedBeaconInfoEventContent
type Redacted = RedactedBeaconInfoEventContent
The redacted form of the event’s content.
source§fn redact(self, version: &RoomVersionId) -> RedactedBeaconInfoEventContent
fn redact(self, version: &RoomVersionId) -> RedactedBeaconInfoEventContent
Transform
self
into a redacted form (removing most or all fields) according to the spec. Read moresource§impl Serialize for BeaconInfoEventContent
impl Serialize for BeaconInfoEventContent
source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
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
source§impl StateEventContent for BeaconInfoEventContent
impl StateEventContent for BeaconInfoEventContent
§type StateKey = OwnedUserId
type StateKey = OwnedUserId
The type of the event’s
state_key
field.source§impl StaticStateEventContent for BeaconInfoEventContent
impl StaticStateEventContent for BeaconInfoEventContent
§type PossiblyRedacted = PossiblyRedactedBeaconInfoEventContent
type PossiblyRedacted = PossiblyRedactedBeaconInfoEventContent
The possibly redacted form of the event’s content.
§type Unsigned = StateUnsigned<<BeaconInfoEventContent as StaticStateEventContent>::PossiblyRedacted>
type Unsigned = StateUnsigned<<BeaconInfoEventContent as StaticStateEventContent>::PossiblyRedacted>
The type of the event’s
unsigned
field.Auto Trait Implementations§
impl Freeze for BeaconInfoEventContent
impl RefUnwindSafe for BeaconInfoEventContent
impl Send for BeaconInfoEventContent
impl Sync for BeaconInfoEventContent
impl Unpin for BeaconInfoEventContent
impl UnwindSafe for BeaconInfoEventContent
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)