Enum matrix_sdk::room::Room

pub enum Room {
    Joined(Joined),
    Left(Left),
    Invited(Invited),
}

An enum that abstracts over the different states a room can be in.

Variants

Joined(Joined)

The room in the join state.

Tuple Fields of Joined

0: Joined

Left(Left)

The room in the left state.

Tuple Fields of Left

0: Left

Invited(Invited)

The room in the invited state.

Tuple Fields of Invited

0: Invited

Methods from Deref<Target = Common>

pub async fn avatar(&self, format: MediaFormat) -> Result<Option<Vec<u8>>>

Gets the avatar of this room, if set.

Returns the avatar. If a thumbnail is requested no guarantee on the size of the image is given.

Arguments

• format - The desired format of the avatar.

Example

let client = Client::new(homeserver).unwrap();
client.login(user, "password", None, None).await.unwrap();
let room_id = room_id!("!roomid:example.com");
let room = client
    .get_joined_room(&room_id)
    .unwrap();
if let Some(avatar) = room.avatar(MediaFormat::File).await.unwrap() {
    std::fs::write("avatar.png", avatar);
}

pub async fn messages(
    &self,
    request: impl Into<Request<'_>>
) -> HttpResult<Response>

Sends a request to /_matrix/client/r0/rooms/{room_id}/messages and returns a get_message_events::Response that contains a chunk of room and state events (AnyRoomEvent and AnyStateEvent).

Arguments

• request - The easiest way to create this request is using the get_message_events::Request itself.

Examples

use matrix_sdk::Client;

let room_id = room_id!("!roomid:example.com");
let request = MessagesRequest::backward(&room_id, "t47429-4392820_219380_26003_2265");

let mut client = Client::new(homeserver).unwrap();
assert!(room.messages(request).await.is_ok());

pub async fn event(&self, request: impl Into<Request<'_>>) -> Result<RoomEvent>

Sends a request to /_matrix/client/r0/rooms/{roomId}/event/{eventId} and returns a get_room_event::Response that contains a event (AnyRoomEvent).

pub async fn sync_members(&self) -> Result<Option<MembersResponse>>

Sync the member list with the server.

This method will de-duplicate requests if it is called multiple times in quick succession, in that case the return value will be None.

pub async fn active_members(&self) -> Result<Vec<RoomMember>>

Get active members for this room, includes invited, joined members.

Note: This method will fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Because of that, it might panic if it isn’t run on a tokio thread.

Use active_members_no_sync() if you want a method that doesn’t do any requests.

pub async fn active_members_no_sync(&self) -> Result<Vec<RoomMember>>

Get active members for this room, includes invited, joined members.

Note: This method will fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Because of that, it might panic if it isn’t run on a tokio thread.

Use active_members() if you want to ensure to always get the full member list.

pub async fn joined_members(&self) -> Result<Vec<RoomMember>>

Get all the joined members of this room.

Note: This method will fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Because of that it might panic if it isn’t run on a tokio thread.

Use joined_members_no_sync() if you want a method that doesn’t do any requests.

pub async fn joined_members_no_sync(&self) -> Result<Vec<RoomMember>>

Get all the joined members of this room.

Note: This method will not fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Thus, members could be missing from the list.

Use joined_members() if you want to ensure to always get the full member list.

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

Get a specific member of this room.

Note: This method will fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Because of that it might panic if it isn’t run on a tokio thread.

Use get_member_no_sync() if you want a method that doesn’t do any requests.

Arguments

• user_id - The ID of the user that should be fetched out of the store.

pub async fn get_member_no_sync(
    &self,
    user_id: &UserId
) -> Result<Option<RoomMember>>

Get a specific member of this room.

Note: This method will not fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Thus, members could be missing.

Use get_member() if you want to ensure to always have the full member list to chose from.

Arguments

• user_id - The ID of the user that should be fetched out of the store.

pub async fn members(&self) -> Result<Vec<RoomMember>>

Get all members for this room, includes invited, joined and left members.

Note: This method will fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Because of that it might panic if it isn’t run on a tokio thread.

Use members_no_sync() if you want a method that doesn’t do any requests.

pub async fn members_no_sync(&self) -> Result<Vec<RoomMember>>

Get all members for this room, includes invited, joined and left members.

Note: This method will not fetch the members from the homeserver if the member list isn’t synchronized due to member lazy loading. Thus, members could be missing.

Use members() if you want to ensure to always get the full member list.

pub async fn get_state_events(
    &self,
    event_type: EventType
) -> Result<Vec<Raw<AnySyncStateEvent>>>

Get all state events of a given type in this room.

pub async fn get_state_event(
    &self,
    event_type: EventType,
    state_key: &str
) -> Result<Option<Raw<AnySyncStateEvent>>>

Get a specific state event in this room.

pub async fn contains_only_verified_devices(&self) -> Result<bool>

This is supported on encryption only.

Check if all members of this room are verified and all their devices are verified.

Returns true if all devices in the room are verified, otherwise false.

Trait Implementations

impl Clone for Room

fn clone(&self) -> Room

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Room

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

Formats the value using the given formatter.

impl Deref for Room

type Target = Common

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl EventHandlerContext for Room

This event handler context argument is only applicable to room-specific events.

Trying to use it in the event handler for another event, for example a global account data or presence event, will result in the event handler being skipped and an error getting logged.

fn from_data(data: &EventHandlerData<'_>) -> Option<Self>

impl From<Common> for Room

fn from(room: Common) -> Self

Performs the conversion.

impl From<Invited> for Room

fn from(room: Invited) -> Self

Performs the conversion.

impl From<Joined> for Room

fn from(room: Joined) -> Self

Performs the conversion.

impl From<Left> for Room

fn from(room: Left) -> Self

Performs the conversion.