Struct PossiblyRedactedRoomMemberEventContent 

#[non_exhaustive]
pub struct PossiblyRedactedRoomMemberEventContent {
    pub avatar_url: Option<OwnedMxcUri>,
    pub displayname: Option<String>,
    pub is_direct: Option<bool>,
    pub membership: MembershipState,
    pub third_party_invite: Option<PossiblyRedactedThirdPartyInvite>,
    pub blurhash: Option<String>,
    pub reason: Option<String>,
    pub join_authorized_via_users_server: Option<OwnedUserId>,
}

The possibly redacted form of RoomMemberEventContent.

This type is used when it’s not obvious whether the content is redacted or not.

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.

avatar_url: Option<OwnedMxcUri>

The avatar URL for this user, if any.

This is added by the homeserver. If you activate the compat-empty-string-null feature, this field being an empty string in JSON will result in None here during deserialization.

displayname: Option<String>

The display name for this user, if any.

This is added by the homeserver.

is_direct: Option<bool>

Flag indicating whether the room containing this event was created with the intention of being a direct chat.

membership: MembershipState

The membership state of this user.

third_party_invite: Option<PossiblyRedactedThirdPartyInvite>

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

blurhash: Option<String>

The BlurHash for the avatar pointed to by avatar_url.

This uses the unstable prefix in MSC2448.

reason: Option<String>

User-supplied text for why their membership has changed.

For kicks and bans, this is typically the reason for the kick or ban. For other membership changes, this is a way for the user to communicate their intent without having to send a message to the room, such as in a case where Bob rejects an invite from Alice about an upcoming concert, but can’t make it that day.

Clients are not recommended to show this reason to users when receiving an invite due to the potential for spam and abuse. Hiding the reason behind a button or other component is recommended.

join_authorized_via_users_server: Option<OwnedUserId>

Arbitrarily chosen UserId (MxID) of a local user who can send an invite.

Implementations

impl PossiblyRedactedRoomMemberEventContent

pub fn new( membership: MembershipState, ) -> PossiblyRedactedRoomMemberEventContent

Creates a new PossiblyRedactedRoomMemberEventContent with the given membership state.

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.

This requires data from the full event:

• The previous details computed from event.unsigned.prev_content,
• The sender of the event,
• The state key of the event.

Check the specification for details.

Trait Implementations

impl Clone for PossiblyRedactedRoomMemberEventContent

fn clone(&self) -> PossiblyRedactedRoomMemberEventContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PossiblyRedactedRoomMemberEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PossiblyRedactedRoomMemberEventContent

fn deserialize<__D>( __deserializer: __D, ) -> Result<PossiblyRedactedRoomMemberEventContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PossiblyRedactedRoomMemberEventContent> for AnyPossiblyRedactedStateEventContent

fn from( c: PossiblyRedactedRoomMemberEventContent, ) -> AnyPossiblyRedactedStateEventContent

Converts to this type from the input type.

impl From<RedactedRoomMemberEventContent> for PossiblyRedactedRoomMemberEventContent

fn from( value: RedactedRoomMemberEventContent, ) -> PossiblyRedactedRoomMemberEventContent

Converts to this type from the input type.

impl From<RoomMemberEventContent> for PossiblyRedactedRoomMemberEventContent

fn from(value: RoomMemberEventContent) -> PossiblyRedactedRoomMemberEventContent

Converts to this type from the input type.

impl PossiblyRedactedStateEventContent for PossiblyRedactedRoomMemberEventContent

type StateKey = OwnedUserId

The type of the event’s state_key field.

fn event_type(&self) -> StateEventType

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

impl RedactContent for PossiblyRedactedRoomMemberEventContent

type Redacted = PossiblyRedactedRoomMemberEventContent

The redacted form of the event’s content.

fn redact( self, rules: &RedactionRules, ) -> PossiblyRedactedRoomMemberEventContent

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

impl Serialize for PossiblyRedactedRoomMemberEventContent

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.

impl StaticEventContent for PossiblyRedactedRoomMemberEventContent

const TYPE: &'static str = RoomMemberEventContent::TYPE

The statically-known part of the event type.

type IsPrefix = <RoomMemberEventContent as StaticEventContent>::IsPrefix

Whether the statically-known part of the event type is the prefix.

impl JsonCastable<AnyPossiblyRedactedStateEventContent> for PossiblyRedactedRoomMemberEventContent