Struct ruma::events::RedactedStateEvent
source · pub struct RedactedStateEvent<C>where
C: RedactedStateEventContent,{
pub content: C,
pub event_id: OwnedEventId,
pub sender: OwnedUserId,
pub origin_server_ts: MilliSecondsSinceUnixEpoch,
pub room_id: OwnedRoomId,
pub state_key: <C as RedactedStateEventContent>::StateKey,
pub unsigned: RedactedUnsigned,
}
Expand description
A redacted state event.
RedactedStateEvent
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 RedactedStateEventContent>::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: RedactedUnsigned
Additional key-value pairs not signed by the homeserver.
Implementations§
source§impl RedactedStateEvent<RedactedRoomMemberEventContent>
impl RedactedStateEvent<RedactedRoomMemberEventContent>
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 membership_change<'a>(
&'a self,
prev_details: Option<MembershipDetails<'a>>,
) -> MembershipChange<'a>
pub fn membership_change<'a>( &'a self, prev_details: Option<MembershipDetails<'a>>, ) -> MembershipChange<'a>
Helper function for membership change.
Since redacted events don’t have unsigned.prev_content
, you have to pass the .details()
of the previous m.room.member
event manually (if there is a previous m.room.member
event).
Check the specification for details.
Trait Implementations§
source§impl<C> Clone for RedactedStateEvent<C>
impl<C> Clone for RedactedStateEvent<C>
source§fn clone(&self) -> RedactedStateEvent<C>
fn clone(&self) -> RedactedStateEvent<C>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<C> Debug for RedactedStateEvent<C>
impl<C> Debug for RedactedStateEvent<C>
source§impl<'de, C> Deserialize<'de> for RedactedStateEvent<C>where
C: RedactedStateEventContent + EventContentFromType,
impl<'de, C> Deserialize<'de> for RedactedStateEvent<C>where
C: RedactedStateEventContent + EventContentFromType,
source§fn deserialize<D>(
deserializer: D,
) -> Result<RedactedStateEvent<C>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D,
) -> Result<RedactedStateEvent<C>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
source§impl<C> From<RedactedStateEvent<C>> for RedactedSyncStateEvent<C>where
C: RedactedStateEventContent,
impl<C> From<RedactedStateEvent<C>> for RedactedSyncStateEvent<C>where
C: RedactedStateEventContent,
source§fn from(event: RedactedStateEvent<C>) -> RedactedSyncStateEvent<C>
fn from(event: RedactedStateEvent<C>) -> RedactedSyncStateEvent<C>
source§impl<C> Ord for RedactedStateEvent<C>where
C: RedactedStateEventContent,
impl<C> Ord for RedactedStateEvent<C>where
C: RedactedStateEventContent,
source§fn cmp(&self, other: &RedactedStateEvent<C>) -> Ordering
fn cmp(&self, other: &RedactedStateEvent<C>) -> Ordering
Compares EventId
s and orders them lexicographically.
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl<C> PartialEq for RedactedStateEvent<C>where
C: RedactedStateEventContent,
impl<C> PartialEq for RedactedStateEvent<C>where
C: RedactedStateEventContent,
source§impl<C> PartialOrd for RedactedStateEvent<C>where
C: RedactedStateEventContent,
impl<C> PartialOrd for RedactedStateEvent<C>where
C: RedactedStateEventContent,
source§fn partial_cmp(&self, other: &RedactedStateEvent<C>) -> Option<Ordering>
fn partial_cmp(&self, other: &RedactedStateEvent<C>) -> Option<Ordering>
Compares EventId
s and orders them lexicographically.
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl<C> Eq for RedactedStateEvent<C>where
C: RedactedStateEventContent,
Auto Trait Implementations§
impl<C> Freeze for RedactedStateEvent<C>
impl<C> RefUnwindSafe for RedactedStateEvent<C>
impl<C> Send for RedactedStateEvent<C>
impl<C> Sync for RedactedStateEvent<C>
impl<C> Unpin for RedactedStateEvent<C>
impl<C> UnwindSafe for RedactedStateEvent<C>
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
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)
clone_to_uninit
)source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.