refactor: Move linked_chunk from matrix-sdk to matrix-sdk-common.

Author: Hywan

Cargo.lock

@@ -12,4 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//! Event cache store and common types shared with `matrix_sdk::event_cache`.
+
 pub mod store;

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

@@ -21,7 +21,10 @@ uniffi = ["dep:uniffi"]
 
 [dependencies]
 async-trait = { workspace = true }
+eyeball-im = { workspace = true }
 futures-core = { workspace = true }
+futures-util = { workspace = true }
+imbl = { workspace = true }
 ruma = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }

crates/matrix-sdk-common/Cargo.toml

@@ -25,6 +25,7 @@ pub mod debug;
 pub mod deserialized_responses;
 pub mod executor;
 pub mod failures_cache;
+pub mod linked_chunk;
 pub mod ring_buffer;
 pub mod store_locks;
 pub mod timeout;

crates/matrix-sdk-common/src/lib.rs

@@ -13,6 +13,7 @@
 // limitations under the License.
 
 #![allow(dead_code)]
+#![allow(rustdoc::private_intra_doc_links)]
 
 //! A linked chunk is the underlying data structure that holds all events.
 
@@ -56,7 +57,7 @@ macro_rules! assert_items_eq {
                     let chunk = $iterator .next().expect("next chunk (expect items)");
                     assert!(chunk.is_items(), "chunk should contain items");
 
-                    let $crate::event_cache::linked_chunk::ChunkContent::Items(items) = chunk.content() else {
+                    let $crate::linked_chunk::ChunkContent::Items(items) = chunk.content() else {
                         unreachable!()
                     };
 
@@ -934,7 +935,6 @@ impl ChunkIdentifierGenerator {
 #[repr(transparent)]
 pub struct ChunkIdentifier(u64);
 
-#[cfg(test)]
 impl PartialEq<u64> for ChunkIdentifier {
     fn eq(&self, other: &u64) -> bool {
         self.0 == *other
@@ -963,7 +963,7 @@ impl Position {
     /// # Panic
     ///
     /// This method will panic if it will underflow, i.e. if the index is 0.
-    pub(super) fn decrement_index(&mut self) {
+    pub fn decrement_index(&mut self) {
         self.1 = self.1.checked_sub(1).expect("Cannot decrement the index because it's already 0");
     }
 }
@@ -1346,7 +1346,8 @@ where
 }
 
 /// A type representing what to do when the system has to handle an empty chunk.
-pub(crate) enum EmptyChunk {
+#[derive(Debug)]
+pub enum EmptyChunk {
     /// Keep the empty chunk.
     Keep,
 

crates/matrix-sdk/src/event_cache/linked_chunk/as_vector.rs renamed to crates/matrix-sdk-common/src/linked_chunk/as_vector.rs

@@ -54,7 +54,6 @@ use self::paginator::PaginatorError;
 use crate::{client::WeakClient, Client};
 
 mod deduplicator;
-mod linked_chunk;
 mod pagination;
 mod room;
 

crates/matrix-sdk/src/event_cache/linked_chunk/mod.rs renamed to crates/matrix-sdk-common/src/linked_chunk/mod.rs

@@ -18,11 +18,11 @@ use std::{future::Future, ops::ControlFlow, sync::Arc, time::Duration};
 
 use eyeball::Subscriber;
 use matrix_sdk_base::deserialized_responses::SyncTimelineEvent;
+use matrix_sdk_common::linked_chunk::ChunkContent;
 use tokio::time::timeout;
 use tracing::{debug, instrument, trace};
 
 use super::{
-    linked_chunk::ChunkContent,
     paginator::{PaginationResult, PaginatorState},
     room::{
         events::{Gap, RoomEvents},

crates/matrix-sdk/src/event_cache/linked_chunk/updates.rs renamed to crates/matrix-sdk-common/src/linked_chunk/updates.rs

@@ -15,13 +15,13 @@
 use std::cmp::Ordering;
 
 use matrix_sdk_common::deserialized_responses::SyncTimelineEvent;
+use matrix_sdk_common::linked_chunk::{
+    Chunk, ChunkIdentifier, EmptyChunk, Error, Iter, LinkedChunk, Position,
+};
 use ruma::OwnedEventId;
 use tracing::{debug, error, warn};
 
-use super::super::{
-    deduplicator::{Decoration, Deduplicator},
-    linked_chunk::{Chunk, ChunkIdentifier, EmptyChunk, Error, Iter, LinkedChunk, Position},
-};
+use super::super::deduplicator::{Decoration, Deduplicator};
 
 /// An alias for the real event type.
 pub(crate) type Event = SyncTimelineEvent;