Struct ruma_events::room::member::RedactedRoomMemberEventContent

#[non_exhaustive]
pub struct RedactedRoomMemberEventContent {
    pub membership: MembershipState,
    pub third_party_invite: Option<RedactedThirdPartyInvite>,
    pub join_authorized_via_users_server: Option<OwnedUserId>,
}

A member event that has been redacted.

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.

membership: MembershipState

The membership state of this user.

third_party_invite: Option<RedactedThirdPartyInvite>

If this member event is the successor to a third party invitation, this field will contain information about that invitation.

join_authorized_via_users_server: Option<OwnedUserId>

An arbitrary user who has the power to issue invites.

This is redacted in room versions 8 and below. It is used for validating joins when the join rule is restricted.

Implementations

impl RedactedRoomMemberEventContent

pub fn new(membership: MembershipState) -> Self

Create a RedactedRoomMemberEventContent with the given membership.

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.

pub fn membership_change<'a>( &'a self, prev_details: Option<MembershipDetails<'a>>, sender: &UserId, state_key: &UserId, ) -> 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).

This also requires data from the full event:

• The sender of the event,
• The state key of the event.

Check the specification for details.

Trait Implementations

impl Clone for RedactedRoomMemberEventContent

fn clone(&self) -> RedactedRoomMemberEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RedactedRoomMemberEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RedactedRoomMemberEventContent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for RedactedRoomMemberEventContent

type EventType = StateEventType

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

fn event_type(&self) -> StateEventType

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

impl RedactedStateEventContent for RedactedRoomMemberEventContent

type StateKey = OwnedUserId

The type of the event’s state_key field.

impl Serialize for RedactedRoomMemberEventContent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.