mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-24 08:36:10 -04:00
Code Issues Packages Projects Releases Wiki Activity

feat(sdk): Implement SlidingSync::stop_sync.

Browse Source 
In case it's not obvious to drop the `Stream` returned by
`SlidingSync::sync` immediately to “stop” the sync-loop, one can use the
new `stop_sync` method to do achieve the same result.
This commit is contained in:
Ivan Enderlin
2023-05-24 08:41:16 +02:00
parent b8580b76f7
commit 99bbf2a42b
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
crates/matrix-sdk/src/sliding_sync/mod.rs
View File

@@ -665,6 +665,18 @@ impl SlidingSync {
}
}
/// 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
/// stops gracefully and as soon as it returns.
pub async fn stop_sync(&self) -> Result<(), Error> {
self.inner.internal_channel_send(SlidingSyncInternalMessage::SyncLoopStop).await
}
/// Resets the lists.
pub fn reset_lists(&self) -> Result<(), Error> {
let lists = self.inner.lists.read().unwrap();
@@ -679,7 +691,10 @@ impl SlidingSync {
impl SlidingSyncInner {
/// Send a message over the internal channel.
async fn internal_channel_send(&self, message: SlidingSyncInternalMessage) -> Result<()> {
async fn internal_channel_send(
&self,
message: SlidingSyncInternalMessage,
) -> Result<(), Error> {
Ok(self
.internal_channel
.0