diff --git a/crates/matrix-sdk-ui/src/room_list_service/mod.rs b/crates/matrix-sdk-ui/src/room_list_service/mod.rs index 6e37b30e3..c0d716524 100644 --- a/crates/matrix-sdk-ui/src/room_list_service/mod.rs +++ b/crates/matrix-sdk-ui/src/room_list_service/mod.rs @@ -239,7 +239,7 @@ impl RoomListService { break; } - // Sync-loop has terminated. + // Sync loop has terminated. None => { let next_state = State::Terminated { from: Box::new(next_state) }; self.state.set(next_state); @@ -256,7 +256,7 @@ impl RoomListService { /// /// It's of utter importance to call this method rather than stop polling /// the `Stream` returned by [`Self::sync`] because it will force the - /// cancellation and exit the sync-loop, i.e. it will cancel any + /// cancellation and exit the sync loop, i.e. it will cancel any /// in-flight HTTP requests, cancel any pending futures etc. and put the /// service into a termination state. /// @@ -278,14 +278,14 @@ impl RoomListService { /// /// This is used by [`SyncService`][crate::SyncService]. /// - /// **Warning**: This method **must not** be called while the sync-loop is + /// **Warning**: This method **must not** be called while the sync loop is /// running! pub(crate) async fn expire_sync_session(&self) { self.sliding_sync.expire_session().await; // Usually, when the session expires, it leads the state to be `Error`, // thus some actions (like refreshing the lists) are executed. However, - // if the sync-loop has been stopped manually, the state is `Terminated`, and + // if the sync loop has been stopped manually, the state is `Terminated`, and // when the session is forced to expire, the state remains `Terminated`, thus // the actions aren't executed as expected. Consequently, let's update the // state. diff --git a/crates/matrix-sdk/src/sliding_sync/list/mod.rs b/crates/matrix-sdk/src/sliding_sync/list/mod.rs index 343cd6b60..6197b2671 100644 --- a/crates/matrix-sdk/src/sliding_sync/list/mod.rs +++ b/crates/matrix-sdk/src/sliding_sync/list/mod.rs @@ -492,7 +492,7 @@ impl SlidingSyncListInner { } /// Send a message over the internal channel if there is a receiver, i.e. if - /// the sync-loop is running. + /// the sync loop is running. #[instrument] fn internal_channel_send_if_possible(&self, message: SlidingSyncInternalMessage) { // If there is no receiver, the send will fail, but that's OK here. diff --git a/crates/matrix-sdk/src/sliding_sync/mod.rs b/crates/matrix-sdk/src/sliding_sync/mod.rs index 0a3e8af3b..2c7e8e040 100644 --- a/crates/matrix-sdk/src/sliding_sync/mod.rs +++ b/crates/matrix-sdk/src/sliding_sync/mod.rs @@ -660,7 +660,7 @@ impl SlidingSync { spawn(future.instrument(Span::current())).await.unwrap() } - /// Create a _new_ Sliding Sync sync-loop. + /// Create a _new_ Sliding Sync sync loop. /// /// This method returns a `Stream`, which will send requests and will handle /// responses automatically. Lists and rooms are updated automatically. @@ -714,7 +714,7 @@ impl SlidingSync { continue; } - // Here, errors we **cannot** ignore, and that must stop the sync-loop. + // Here, errors we **cannot** ignore, and that must stop the sync loop. Err(error) => { if error.client_api_error_kind() == Some(&ErrorKind::UnknownPos) { // The Sliding Sync session has expired. Let's reset `pos` and sticky parameters. @@ -737,13 +737,13 @@ impl SlidingSync { } } - /// Force to stop the sync-loop ([`Self::sync`]) if it's running. + /// Force to stop the sync loop ([`Self::sync`]) if it's running. /// /// Usually, dropping the `Stream` returned by [`Self::sync`] should be /// enough to “stop” it, but depending of how this `Stream` is used, it /// might not be obvious to drop it immediately (thinking of using this API /// over FFI; the foreign-language might not be able to drop a value - /// immediately). Thus, calling this method will ensure that the sync-loop + /// immediately). Thus, calling this method will ensure that the sync loop /// stops gracefully and as soon as it returns. pub fn stop_sync(&self) -> Result<()> { Ok(self.inner.internal_channel_send(SlidingSyncInternalMessage::SyncLoopStop)?) @@ -759,7 +759,7 @@ impl SlidingSync { /// multiple sliding syncs being run in parallel, and one of them has /// expired). /// - /// This method **MUST** be called when the sync-loop is stopped. + /// This method **MUST** be called when the sync loop is stopped. #[doc(hidden)] pub async fn expire_session(&self) { info!("Session expired; resetting `pos` and sticky parameters"); @@ -787,7 +787,7 @@ impl SlidingSyncInner { } /// Send a message over the internal channel if there is a receiver, i.e. if - /// the sync-loop is running. + /// the sync loop is running. #[instrument] fn internal_channel_send_if_possible(&self, message: SlidingSyncInternalMessage) { // If there is no receiver, the send will fail, but that's OK here. @@ -1577,24 +1577,24 @@ mod tests { .sync_mode(SlidingSyncMode::new_selective().add_range(0..=10))]) .await?; - // Start the sync-loop. + // Start the sync loop. let stream = sliding_sync.sync(); pin_mut!(stream); - // The sync-loop is actually running. + // The sync loop is actually running. assert!(stream.next().await.is_some()); - // Stop the sync-loop. + // Stop the sync loop. sliding_sync.stop_sync()?; - // The sync-loop is actually stopped. + // The sync loop is actually stopped. assert!(stream.next().await.is_none()); - // Start a new sync-loop. + // Start a new sync loop. let stream = sliding_sync.sync(); pin_mut!(stream); - // The sync-loop is actually running. + // The sync loop is actually running. assert!(stream.next().await.is_some()); Ok(())