Struct ruma::events::OriginalStateEvent
source · [−]pub struct OriginalStateEvent<C>where
C: StateEventContent,{
pub content: C,
pub event_id: OwnedEventId,
pub sender: OwnedUserId,
pub origin_server_ts: MilliSecondsSinceUnixEpoch,
pub room_id: OwnedRoomId,
pub state_key: <C as StateEventContent>::StateKey,
pub unsigned: <C as StateEventContent>::Unsigned,
}
events
only.Expand description
An unredacted state event.
OriginalStateEvent
implements the comparison traits using only the event_id
field, a sorted
list would be sorted lexicographically based on the event’s EventId
.
Fields
content: C
Data specific to the event type.
event_id: OwnedEventId
The globally unique event identifier for the user who sent the event.
sender: OwnedUserId
The fully-qualified ID of the user who sent this event.
origin_server_ts: MilliSecondsSinceUnixEpoch
Timestamp in milliseconds on originating homeserver when this event was sent.
room_id: OwnedRoomId
The ID of the room associated with this event.
state_key: <C as StateEventContent>::StateKey
A unique key which defines the overwriting semantics for this piece of room state.
This is often an empty string, but some events send a UserId
to show which user the event
affects.
unsigned: <C as StateEventContent>::Unsigned
Additional key-value pairs not signed by the homeserver.
Implementations
sourceimpl OriginalStateEvent<RoomMemberEventContent>
impl OriginalStateEvent<RoomMemberEventContent>
sourcepub fn details(&self) -> MembershipDetails<'_>
pub fn details(&self) -> MembershipDetails<'_>
Obtain the details about this event that are required to calculate a membership change.
This is required when you want to calculate the change a redacted m.room.member
event
made.
sourcepub fn prev_content(&self) -> Option<&RoomMemberEventContent>
pub fn prev_content(&self) -> Option<&RoomMemberEventContent>
Get a reference to the prev_content
in unsigned, if it exists.
Shorthand for event.unsigned.prev_content.as_ref()
sourcepub fn membership_change(&self) -> MembershipChange<'_>
pub fn membership_change(&self) -> MembershipChange<'_>
Helper function for membership change.
Check the specification for details.
Trait Implementations
sourceimpl<C> Clone for OriginalStateEvent<C>where
C: Clone + StateEventContent,
<C as StateEventContent>::StateKey: Clone,
<C as StateEventContent>::Unsigned: Clone,
impl<C> Clone for OriginalStateEvent<C>where
C: Clone + StateEventContent,
<C as StateEventContent>::StateKey: Clone,
<C as StateEventContent>::Unsigned: Clone,
sourcefn clone(&self) -> OriginalStateEvent<C>
fn clone(&self) -> OriginalStateEvent<C>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl<C> Debug for OriginalStateEvent<C>where
C: Debug + StateEventContent,
<C as StateEventContent>::StateKey: Debug,
<C as StateEventContent>::Unsigned: Debug,
impl<C> Debug for OriginalStateEvent<C>where
C: Debug + StateEventContent,
<C as StateEventContent>::StateKey: Debug,
<C as StateEventContent>::Unsigned: Debug,
sourceimpl<'de, C> Deserialize<'de> for OriginalStateEvent<C>where
C: StateEventContent,
impl<'de, C> Deserialize<'de> for OriginalStateEvent<C>where
C: StateEventContent,
sourcefn deserialize<D>(
deserializer: D
) -> Result<OriginalStateEvent<C>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<OriginalStateEvent<C>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
sourceimpl<C> From<OriginalStateEvent<C>> for OriginalSyncStateEvent<C>where
C: StateEventContent,
impl<C> From<OriginalStateEvent<C>> for OriginalSyncStateEvent<C>where
C: StateEventContent,
sourcefn from(event: OriginalStateEvent<C>) -> OriginalSyncStateEvent<C>
fn from(event: OriginalStateEvent<C>) -> OriginalSyncStateEvent<C>
sourceimpl<C> Ord for OriginalStateEvent<C>where
C: StateEventContent,
impl<C> Ord for OriginalStateEvent<C>where
C: StateEventContent,
sourcefn cmp(&self, other: &OriginalStateEvent<C>) -> Ordering
fn cmp(&self, other: &OriginalStateEvent<C>) -> Ordering
Compares EventId
s and orders them lexicographically.
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl<C> PartialEq<OriginalStateEvent<C>> for OriginalStateEvent<C>where
C: StateEventContent,
impl<C> PartialEq<OriginalStateEvent<C>> for OriginalStateEvent<C>where
C: StateEventContent,
sourceimpl<C> PartialOrd<OriginalStateEvent<C>> for OriginalStateEvent<C>where
C: StateEventContent,
impl<C> PartialOrd<OriginalStateEvent<C>> for OriginalStateEvent<C>where
C: StateEventContent,
sourcefn partial_cmp(&self, other: &OriginalStateEvent<C>) -> Option<Ordering>
fn partial_cmp(&self, other: &OriginalStateEvent<C>) -> Option<Ordering>
Compares EventId
s and orders them lexicographically.
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl<C> Redact for OriginalStateEvent<C>where
C: StateEventContent + RedactContent,
<C as RedactContent>::Redacted: RedactedStateEventContent,
<<C as RedactContent>::Redacted as StateEventContent>::StateKey == <C as StateEventContent>::StateKey,
impl<C> Redact for OriginalStateEvent<C>where
C: StateEventContent + RedactContent,
<C as RedactContent>::Redacted: RedactedStateEventContent,
<<C as RedactContent>::Redacted as StateEventContent>::StateKey == <C as StateEventContent>::StateKey,
type Redacted = RedactedStateEvent<<C as RedactContent>::Redacted>
type Redacted = RedactedStateEvent<<C as RedactContent>::Redacted>
sourcefn redact(
self,
redaction: SyncRoomRedactionEvent,
version: &RoomVersionId
) -> <OriginalStateEvent<C> as Redact>::Redacted
fn redact(
self,
redaction: SyncRoomRedactionEvent,
version: &RoomVersionId
) -> <OriginalStateEvent<C> as Redact>::Redacted
self
into a redacted form (removing most fields) according to the spec. Read moresourceimpl<C> Serialize for OriginalStateEvent<C>where
C: StateEventContent,
impl<C> Serialize for OriginalStateEvent<C>where
C: StateEventContent,
sourcefn 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,
impl<C> Eq for OriginalStateEvent<C>where
C: StateEventContent,
Auto Trait Implementations
impl<C> RefUnwindSafe for OriginalStateEvent<C>where
C: RefUnwindSafe,
<C as StateEventContent>::StateKey: RefUnwindSafe,
<C as StateEventContent>::Unsigned: RefUnwindSafe,
impl<C> Send for OriginalStateEvent<C>where
C: Send,
<C as StateEventContent>::StateKey: Send,
<C as StateEventContent>::Unsigned: Send,
impl<C> Sync for OriginalStateEvent<C>where
C: Sync,
<C as StateEventContent>::StateKey: Sync,
<C as StateEventContent>::Unsigned: Sync,
impl<C> Unpin for OriginalStateEvent<C>where
C: Unpin,
<C as StateEventContent>::StateKey: Unpin,
<C as StateEventContent>::Unsigned: Unpin,
impl<C> UnwindSafe for OriginalStateEvent<C>where
C: UnwindSafe,
<C as StateEventContent>::StateKey: UnwindSafe,
<C as StateEventContent>::Unsigned: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.