matrix_sdk_base: expose RoomMember

martinetd · Oct 8, 2020 · f7039d9 · f7039d9
1 parent bc48674
commit f7039d9
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/matrix_sdk_base/src/lib.rs b/matrix_sdk_base/src/lib.rs
@@ -53,7 +53,7 @@ mod state;
 
 pub use client::{BaseClient, BaseClientConfig, RoomState, RoomStateType};
 pub use event_emitter::{CustomEvent, EventEmitter, SyncRoom};
-pub use models::Room;
+pub use models::{Room, RoomMember};
 pub use state::{AllRooms, ClientState};
 
 #[cfg(feature = "encryption")]

diff --git a/matrix_sdk_base/src/models/room_member.rs b/matrix_sdk_base/src/models/room_member.rs
@@ -83,6 +83,14 @@ impl PartialEq for RoomMember {
 }
 
 impl RoomMember {
+    /// Create a new room member.
+    ///
+    /// # Arguments
+    ///
+    /// * `event` - event associated with a member joining, leaving or getting
+    /// invited to a room.
+    ///
+    /// * `room_id` - The unique id of the room this member is part of.
     pub fn new(event: &SyncStateEvent<MemberEventContent>, room_id: &RoomId) -> Self {
         Self {
             name: event.state_key.clone(),