char/matrix-rust-sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add doc comment to RoomName::calculate_name.

Browse source
This commit is contained in:
Denis Kasak 2020-06-10 00:28:56 +02:00
parent e4977d1d2a
commit 4c184a30a2
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
matrix_sdk_base/src/models/room.rs
View file

@ -201,9 +201,14 @@ impl RoomName {
true
}
/// Calculate the canonical display name of a room, taking into account its name, aliases and
/// members.
///
/// The display name is calculated according to [this algorithm][spec].
///
/// [spec]:
/// <https://matrix.org/docs/spec/client_server/latest#calculating-the-display-name-for-a-room>
pub fn calculate_name(&self, members: &HashMap<UserId, RoomMember>) -> String {
// https://matrix.org/docs/spec/client_server/latest#calculating-the-display-name-for-a-room.
// the order in which we check for a name ^^
if let Some(name) = &self.name {
let name = name.trim();
name.to_string()