refactor(sdk): Rename RoomEventCache::event_with_relations to find_event_with_relations.

This patch renames the `RoomEventCache::event_with_relations` method to
`find_event_with_relations` for the sake of clarity, also to match the
other method names, and to match the Rust standard library namings.

Author: Hywan

crates/matrix-sdk-ui/src/timeline/pinned_events_loader.rs

@@ -172,7 +172,8 @@ impl PinnedEventsRoom for Room {
     ) -> BoxFuture<'a, Result<(TimelineEvent, Vec<TimelineEvent>), matrix_sdk::Error>> {
         Box::pin(async move {
             if let Ok((cache, _handles)) = self.event_cache().await {
-                if let Some(ret) = cache.event_with_relations(event_id, related_event_filters).await
+                if let Some(ret) =
+                    cache.find_event_with_relations(event_id, related_event_filters).await
                 {
                     debug!("Loaded pinned event {event_id} and related events from cache");
                     return Ok(ret);

crates/matrix-sdk/src/event_cache/room/mod.rs

@@ -230,18 +230,18 @@ impl RoomEventCache {
             .map(|(_loc, event)| event)
     }
 
-    /// Try to find an event by id in this room, along with its related events.
+    /// Try to find an event by ID in this room, along with its related events.
     ///
     /// You can filter which types of related events to retrieve using
     /// `filter`. `None` will retrieve related events of any type.
     ///
     /// The related events are sorted like this:
-    /// - events saved out-of-band with `super::RoomEventCache::save_events`
-    ///   will be located at the beginning of the array.
-    /// - events present in the linked chunk (be it in memory or in the
-    ///   database) will be sorted according to their ordering in the linked
-    ///   chunk.
-    pub async fn event_with_relations(
+    ///
+    /// - events saved out-of-band (with `RoomEventCache::save_events`) will be
+    ///   located at the beginning of the array.
+    /// - events present in the linked chunk (be it in memory or in the storage)
+    ///   will be sorted according to their ordering in the linked chunk.
+    pub async fn find_event_with_relations(
         &self,
         event_id: &EventId,
         filter: Option<Vec<RelationType>>,
@@ -1819,7 +1819,7 @@ mod tests {
 
         let filter = Some(vec![RelationType::Replacement]);
         let (event, related_events) =
-            room_event_cache.event_with_relations(original_id, filter).await.unwrap();
+            room_event_cache.find_event_with_relations(original_id, filter).await.unwrap();
         // Fetched event is the right one.
         let cached_event_id = event.event_id().unwrap();
         assert_eq!(cached_event_id, original_id);
@@ -1833,7 +1833,7 @@ mod tests {
         // Now we'll filter threads instead, there should be no related events
         let filter = Some(vec![RelationType::Thread]);
         let (event, related_events) =
-            room_event_cache.event_with_relations(original_id, filter).await.unwrap();
+            room_event_cache.find_event_with_relations(original_id, filter).await.unwrap();
         // Fetched event is the right one.
         let cached_event_id = event.event_id().unwrap();
         assert_eq!(cached_event_id, original_id);
@@ -1878,7 +1878,7 @@ mod tests {
         room_event_cache.save_events([associated_related_event]).await;
 
         let (event, related_events) =
-            room_event_cache.event_with_relations(original_id, None).await.unwrap();
+            room_event_cache.find_event_with_relations(original_id, None).await.unwrap();
         // Fetched event is the right one.
         let cached_event_id = event.event_id().unwrap();
         assert_eq!(cached_event_id, original_id);
@@ -1926,7 +1926,7 @@ mod tests {
         room_event_cache.save_events([related_event]).await;
 
         let (event, related_events) =
-            room_event_cache.event_with_relations(&original_event_id, None).await.unwrap();
+            room_event_cache.find_event_with_relations(&original_event_id, None).await.unwrap();
         // Fetched event is the right one.
         let cached_event_id = event.event_id().unwrap();
         assert_eq!(cached_event_id, original_event_id);

crates/matrix-sdk/tests/integration/event_cache.rs

@@ -2573,7 +2573,7 @@ async fn test_relations_ordering() {
 
     // Sanity check: there are no relations for the target event yet.
     let (_, relations) =
-        room_event_cache.event_with_relations(target_event_id, None).await.unwrap();
+        room_event_cache.find_event_with_relations(target_event_id, None).await.unwrap();
     assert!(relations.is_empty());
 
     let edit2 = event_id!("$edit2");
@@ -2623,7 +2623,7 @@ async fn test_relations_ordering() {
 
     // At this point, relations are known for the target event.
     let (_, relations) =
-        room_event_cache.event_with_relations(target_event_id, None).await.unwrap();
+        room_event_cache.find_event_with_relations(target_event_id, None).await.unwrap();
     assert_eq!(relations.len(), 2);
     // And the edit events are correctly ordered according to their position in the
     // linked chunk.
@@ -2654,7 +2654,7 @@ async fn test_relations_ordering() {
 
     // Relations are returned accordingly.
     let (_, relations) =
-        room_event_cache.event_with_relations(target_event_id, None).await.unwrap();
+        room_event_cache.find_event_with_relations(target_event_id, None).await.unwrap();
     assert_eq!(relations.len(), 3);
     assert_eq!(relations[0].event_id().unwrap(), edit2);
     assert_eq!(relations[1].event_id().unwrap(), edit3);
@@ -2675,7 +2675,7 @@ async fn test_relations_ordering() {
     room.event(edit5, None).await.unwrap();
 
     let (_, relations) =
-        room_event_cache.event_with_relations(target_event_id, None).await.unwrap();
+        room_event_cache.find_event_with_relations(target_event_id, None).await.unwrap();
     assert_eq!(relations.len(), 4);
     assert_eq!(relations[0].event_id().unwrap(), edit5);
     assert_eq!(relations[1].event_id().unwrap(), edit2);