chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documentation to RoomVersionId's PartialOrd, Ord impls

Browse Source
This commit is contained in:
Jonas Platte 2020-07-17 00:49:57 +02:00
parent 80ab6f0190
commit d6dfed568f
No known key found for this signature in database
GPG Key ID: 7D261D771D915378
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
ruma-identifiers/src/room_version_id.rs
View File

@ -161,12 +161,22 @@ impl Display for RoomVersionId {
} }
impl PartialOrd for RoomVersionId { impl PartialOrd for RoomVersionId {
/// Compare the two given room version IDs by comparing their string representations.
///
/// Please be aware that room version IDs don't have a defined ordering in the Matrix
/// specification. This implementation only exists to be able to use `RoomVersionId`s or
/// types containing `RoomVersionId`s as `BTreeMap` keys.
fn partial_cmp(&self, other: &RoomVersionId) -> Option<Ordering> { fn partial_cmp(&self, other: &RoomVersionId) -> Option<Ordering> {
self.as_ref().partial_cmp(other.as_ref()) self.as_ref().partial_cmp(other.as_ref())
} }
} }
impl Ord for RoomVersionId { impl Ord for RoomVersionId {
/// Compare the two given room version IDs by comparing their string representations.
///
/// Please be aware that room version IDs don't have a defined ordering in the Matrix
/// specification. This implementation only exists to be able to use `RoomVersionId`s or
/// types containing `RoomVersionId`s as `BTreeMap` keys.
fn cmp(&self, other: &Self) -> Ordering { fn cmp(&self, other: &Self) -> Ordering {
self.as_ref().cmp(other.as_ref()) self.as_ref().cmp(other.as_ref())
} }