Struct matrix_sdk::Room

pub struct Room {
    pub room_id: RoomId,
    pub room_name: RoomName,
    pub own_user_id: UserId,
    pub creator: Option<UserId>,
    pub direct_target: Option<UserId>,
    pub invited_members: HashMap<UserId, RoomMember, RandomState>,
    pub joined_members: HashMap<UserId, RoomMember, RandomState>,
    pub messages: MessageQueue,
    pub typing_users: Vec<UserId, Global>,
    pub power_levels: Option<PowerLevels>,
    pub encrypted: Option<EncryptionInfo>,
    pub unread_highlight: Option<UInt>,
    pub unread_notifications: Option<UInt>,
    pub tombstone: Option<Tombstone>,
}

A Matrix room.

Fields

room_id: RoomId

The unique id of the room.

room_name: RoomName

The name of the room, clients use this to represent a room.

own_user_id: UserId

The mxid of our own user.

creator: Option<UserId>

The mxid of the room creator.

direct_target: Option<UserId>

The mxid of the "direct" target if any

invited_members: HashMap<UserId, RoomMember, RandomState>

The map of invited room members.

joined_members: HashMap<UserId, RoomMember, RandomState>

The map of joined room members.

messages: MessageQueue

A queue of messages, holds no more than 10 of the most recent messages.

This is helpful when using a StateStore to avoid multiple requests to the server for messages.

typing_users: Vec<UserId, Global>

A list of users that are currently typing.

power_levels: Option<PowerLevels>

The power level requirements for specific actions in this room

encrypted: Option<EncryptionInfo>

Optional encryption info, will be Some if the room is encrypted.

unread_highlight: Option<UInt>

Number of unread notifications with highlight flag set.

unread_notifications: Option<UInt>

Number of unread notifications.

tombstone: Option<Tombstone>

The tombstone state of this room.

Implementations

impl Room

pub fn new(room_id: &RoomId, own_user_id: &UserId) -> Room

Create a new room.

Arguments

• room_id - The unique id of the room.

• own_user_id - The mxid of our own user.

pub fn display_name(&self) -> String

Return the display name of the room.

pub fn is_encrypted(&self) -> bool

Is the room a encrypted room.

pub fn encryption_info(&self) -> Option<&EncryptionInfo>

Get the encryption info if any of the room.

Returns None if the room is not encrypted.

pub fn member_is_tracked(&self, user_id: &UserId) -> bool

Check whether the user with the MXID user_id is joined or invited to the room.

Returns true if so, false otherwise.

pub fn get_member(&self, user_id: &UserId) -> Option<&RoomMember>

Get a room member by user ID.

If there is no such member, returns None.

pub fn get_member_mut(&mut self, user_id: &UserId) -> Option<&mut RoomMember>

Get a room member by user ID.

If there is no such member, returns None.

pub fn handle_membership(
    &mut self,
    event: &SyncStateEvent<MemberEventContent>,
    state_event: bool
) -> (bool, HashMap<UserId, bool, RandomState>)

Handle a room.member updating the room state if necessary.

Returns a tuple of:

1. True if the joined member list changed, false otherwise.
2. A map of display name ambiguity status changes (see disambiguation_updates).

pub fn handle_message(&mut self, event: &AnySyncMessageEvent) -> bool

Handle a room.message event and update the MessageQueue if necessary.

Returns true if MessageQueue was added to.

pub fn handle_redaction(&mut self, redacted_event: &SyncRedactionEvent) -> bool

Handle a room.redaction event and update the MessageQueue.

Returns true if MessageQueue was updated. The effected message event has it's contents replaced with the RedactionEventContents and the whole redaction event is added to the Unsigned redacted_because field.

pub fn handle_room_aliases(
    &mut self,
    event: &SyncStateEvent<AliasesEventContent>
) -> bool

Handle a room.aliases event, updating the room state if necessary.

Returns true if the room name changed, false otherwise.

pub fn handle_canonical(
    &mut self,
    event: &SyncStateEvent<CanonicalAliasEventContent>
) -> bool

Handle a room.canonical_alias event, updating the room state if necessary.

Returns true if the room name changed, false otherwise.

pub fn handle_room_name(
    &mut self,
    event: &SyncStateEvent<NameEventContent>
) -> bool

Handle a room.name event, updating the room state if necessary.

Returns true if the room name changed, false otherwise.

pub fn handle_stripped_room_name(
    &mut self,
    event: &StrippedStateEvent<NameEventContent>
) -> bool

Handle a room.name event, updating the room state if necessary.

Returns true if the room name changed, false otherwise.

pub fn handle_power_level(
    &mut self,
    event: &SyncStateEvent<PowerLevelsEventContent>
) -> bool

Handle a room.power_levels event, updating the room state if necessary.

Returns true if the room name changed, false otherwise.

pub fn handle_direct(&mut self, user_id: &UserId) -> bool

Handle setting direct attribute as part of a m.direct event, updating the room if necessary

Returns true if the direct_target changed, false otherwise.

pub fn receive_timeline_event(&mut self, event: &AnySyncRoomEvent) -> bool

Receive a timeline event for this room and update the room state.

Returns true if the joined member list changed, false otherwise.

Arguments

• event - The event of the room.

pub fn receive_state_event(&mut self, event: &AnySyncStateEvent) -> bool

Receive a state event for this room and update the room state.

Returns true if the state of the Room has changed, false otherwise.

Arguments

• event - The event of the room.

pub fn receive_stripped_state_event(
    &mut self,
    event: &AnyStrippedStateEvent
) -> bool

Receive a stripped state event for this room and update the room state.

Returns true if the state of the Room has changed, false otherwise.

Arguments

• event - The AnyStrippedStateEvent sent by the server for invited but not joined rooms.

pub fn receive_presence_event(&mut self, event: &PresenceEvent) -> bool

Receive a presence event for a member of the current room.

Returns true if the event causes a change to the member's presence, false otherwise.

Arguments

• event - The presence event to receive and process.

pub fn update_member_profile(
    &mut self,
    target_member: &UserId,
    event: &SyncStateEvent<MemberEventContent>,
    change: MembershipChange
) -> (bool, HashMap<UserId, bool, RandomState>)

Process an update of a member's profile.

Returns a tuple of:

1. True if the event made changes to the room's state, false otherwise.
2. A map of display name ambiguity status changes (see disambiguation_updates).

Arguments

• target_member - The ID of the member to update.
• event - The profile update event for the specified room member.

pub fn update_member_power(
    member: &mut RoomMember,
    event: &SyncStateEvent<PowerLevelsEventContent>,
    max_power: Int
) -> bool

Process an update of a member's power level.

Arguments

• event - The power level event to process.
• max_power - Maximum power level allowed.

Trait Implementations

impl Clone for Room

pub fn clone(&self) -> Room

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Room

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Room

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Room> for Room

pub fn eq(&self, other: &Room) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Room) -> bool

This method tests for !=.

impl Serialize for Room

pub 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 StructuralPartialEq for Room