Struct ruma::events::beacon_info::BeaconInfoEventContent

source ·
pub struct BeaconInfoEventContent {
    pub description: Option<String>,
    pub live: bool,
    pub ts: MilliSecondsSinceUnixEpoch,
    pub timeout: Duration,
    pub asset: AssetContent,
}
Available on crate features events and unstable-msc3489 only.
Expand description

The content of a beacon_info state.

Fields§

§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

source

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.

source

pub fn start(&mut self)

Starts the beacon_info being live.

source

pub fn stop(&mut self)

Stops the beacon_info from being live.

source

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§

source§

impl Clone for BeaconInfoEventContent

source§

fn clone(&self) -> BeaconInfoEventContent

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 BeaconInfoEventContent

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

§

type EventType = StateEventType

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

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

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

impl From<BeaconInfoEventContent> for AnyStateEventContent

source§

fn from(c: BeaconInfoEventContent) -> AnyStateEventContent

Converts to this type from the input type.
source§

impl RedactContent for BeaconInfoEventContent

§

type Redacted = RedactedBeaconInfoEventContent

The redacted form of the event’s content.
source§

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

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

impl Serialize for BeaconInfoEventContent

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

impl StateEventContent for BeaconInfoEventContent

§

type StateKey = OwnedUserId

The type of the event’s state_key field.
source§

impl StaticEventContent for BeaconInfoEventContent

source§

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

The event type.
source§

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.

Auto Trait Implementations§

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> EventContentFromType for T

source§

fn from_parts(_event_type: &str, content: &RawValue) -> Result<T, Error>

Constructs this event content from the given event type and JSON.
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,

§

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§

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§

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

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,