Struct ruma::events::room::join_rules::RoomJoinRulesEventContent

#[non_exhaustive]
pub struct RoomJoinRulesEventContent {
    pub join_rule: JoinRule,
}

The content of an m.room.join_rules event.

Describes how users are allowed to join the room.

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.

join_rule: JoinRule

The type of rules used for users wishing to join this room.

Implementations

impl RoomJoinRulesEventContent

pub fn new(join_rule: JoinRule) -> RoomJoinRulesEventContent

Creates a new RoomJoinRulesEventContent with the given rule.

pub fn restricted(allow: Vec<AllowRule>) -> RoomJoinRulesEventContent

Creates a new RoomJoinRulesEventContent with the restricted rule and the given set of allow rules.

pub fn knock_restricted(allow: Vec<AllowRule>) -> RoomJoinRulesEventContent

Creates a new RoomJoinRulesEventContent with the knock restricted rule and the given set of allow rules.

Trait Implementations

impl Clone for RoomJoinRulesEventContent

fn clone(&self) -> RoomJoinRulesEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomJoinRulesEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomJoinRulesEventContent

fn deserialize<D>( deserializer: D, ) -> Result<RoomJoinRulesEventContent, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for RoomJoinRulesEventContent

type EventType = StateEventType

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

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

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

impl From<RoomJoinRulesEventContent> for AnyStateEventContent

fn from(c: RoomJoinRulesEventContent) -> AnyStateEventContent

Converts to this type from the input type.

impl PossiblyRedactedStateEventContent for RoomJoinRulesEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

impl RedactContent for RoomJoinRulesEventContent

type Redacted = RedactedRoomJoinRulesEventContent

The redacted form of the event’s content.

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

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

impl Serialize for RoomJoinRulesEventContent

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 StateEventContent for RoomJoinRulesEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

impl StaticEventContent for RoomJoinRulesEventContent

const TYPE: &'static str = "m.room.join_rules"

The event type.

impl StaticStateEventContent for RoomJoinRulesEventContent

type PossiblyRedacted = RoomJoinRulesEventContent

The possibly redacted form of the event’s content.

type Unsigned = StateUnsigned<<RoomJoinRulesEventContent as StaticStateEventContent>::PossiblyRedacted>

The type of the event’s unsigned field.