client-server-api: Return a BTreeSet for get_supported_versions::Response::known_versions()

crates/ruma-client-api/CHANGELOG.md

@@ -3,6 +3,8 @@
 Breaking changes:
 
 - Use `AuthType` for the `auth_type` of `get_uiaa_fallback_page`'s Request.
+- `get_supported_versions::Response::known_versions()` returns a
+  `BTreeSet<MatrixVersion>` instead of a `DoubleEndedIterator`.
 
 Bug fixes:
 

crates/ruma-client-api/src/discovery/get_supported_versions.rs

@@ -4,7 +4,7 @@
 //!
 //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientversions
 
-use std::collections::BTreeMap;
+use std::collections::{BTreeMap, BTreeSet};
 
 use ruma_common::{
     api::{request, response, MatrixVersion, Metadata},
@@ -59,23 +59,20 @@ impl Response {
     /// The versions returned will be sorted from oldest to latest. Use [`.find()`][Iterator::find]
     /// or [`.rfind()`][DoubleEndedIterator::rfind] to look for a minimum or maximum version to use
     /// given some constraint.
-    pub fn known_versions(&self) -> impl DoubleEndedIterator<Item = MatrixVersion> {
+    pub fn known_versions(&self) -> BTreeSet<MatrixVersion> {
         self.versions
             .iter()
             // Parse, discard unknown versions
             .flat_map(|s| s.parse::<MatrixVersion>())
-            // Map to key-value pairs where the key is the major-minor representation
-            // (which can be used as a BTreeMap unlike MatrixVersion itself)
-            .map(|v| (v.into_parts(), v))
-            // Collect to BTreeMap
-            .collect::<BTreeMap<_, _>>()
-            // Return an iterator over just the values (`MatrixVersion`s)
-            .into_values()
+            // Collect to BTreeSet
+            .collect()
     }
 }
 
 #[cfg(test)]
 mod tests {
+    use std::collections::BTreeSet;
+
     use ruma_common::api::MatrixVersion;
 
     use super::Response;
@@ -83,13 +80,13 @@ mod tests {
     #[test]
     fn known_versions() {
         let none = Response::new(vec![]);
-        assert_eq!(none.known_versions().next(), None);
+        assert_eq!(none.known_versions(), BTreeSet::new());
 
         let single_known = Response::new(vec!["r0.6.0".to_owned()]);
-        assert_eq!(single_known.known_versions().collect::<Vec<_>>(), vec![MatrixVersion::V1_0]);
+        assert_eq!(single_known.known_versions(), BTreeSet::from([MatrixVersion::V1_0]));
 
         let single_unknown = Response::new(vec!["v0.0".to_owned()]);
-        assert_eq!(single_unknown.known_versions().next(), None);
+        assert_eq!(single_unknown.known_versions(), BTreeSet::new());
     }
 
     #[test]
@@ -103,8 +100,8 @@ mod tests {
             "v1.2".to_owned(),
         ]);
         assert_eq!(
-            sorted.known_versions().collect::<Vec<_>>(),
-            vec![MatrixVersion::V1_0, MatrixVersion::V1_1, MatrixVersion::V1_2],
+            sorted.known_versions(),
+            BTreeSet::from([MatrixVersion::V1_0, MatrixVersion::V1_1, MatrixVersion::V1_2])
         );
 
         let sorted_reverse = Response::new(vec![
@@ -116,8 +113,8 @@ mod tests {
             "r0.0.1".to_owned(),
         ]);
         assert_eq!(
-            sorted_reverse.known_versions().collect::<Vec<_>>(),
-            vec![MatrixVersion::V1_0, MatrixVersion::V1_1, MatrixVersion::V1_2],
+            sorted_reverse.known_versions(),
+            BTreeSet::from([MatrixVersion::V1_0, MatrixVersion::V1_1, MatrixVersion::V1_2])
         );
 
         let random_order = Response::new(vec![
@@ -129,8 +126,8 @@ mod tests {
             "v1.2".to_owned(),
         ]);
         assert_eq!(
-            random_order.known_versions().collect::<Vec<_>>(),
-            vec![MatrixVersion::V1_0, MatrixVersion::V1_1, MatrixVersion::V1_2],
+            random_order.known_versions(),
+            BTreeSet::from([MatrixVersion::V1_0, MatrixVersion::V1_1, MatrixVersion::V1_2])
         );
     }
 }

crates/ruma-client/src/client/builder.rs

@@ -82,6 +82,7 @@ impl ClientBuilder {
                 )
                 .await?
                 .known_versions()
+                .into_iter()
                 .collect(),
         };