mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-18 21:52:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc(timeline): beef up comments for the long-lived tasks

Browse Source
This commit is contained in:
Benjamin Bouvier
2025-07-01 11:06:17 +02:00
parent e8877fd987
commit 98c331466e
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
crates/matrix-sdk-ui/src/timeline/tasks.rs
View File

@@ -29,7 +29,8 @@ use tracing::{instrument, trace, warn};
use crate::timeline::{event_item::RemoteEventOrigin, TimelineController, TimelineFocus};
/// The task that handles the pinned event IDs updates.
/// Long-lived task, in the pinned events focus mode, that updates the timeline
/// after any changes in the pinned events.
#[instrument(
skip_all,
fields(
@@ -70,7 +71,8 @@ pub(in crate::timeline) async fn pinned_events_task<S>(
}
}
/// The task that handles the [`RoomEventCacheUpdate`]s.
/// Long-lived task that forwards the [`RoomEventCacheUpdate`]s (remote echoes)
/// to the timeline.
pub(in crate::timeline) async fn room_event_cache_updates_task(
room_event_cache: RoomEventCache,
timeline_controller: TimelineController,
@@ -157,7 +159,8 @@ pub(in crate::timeline) async fn room_event_cache_updates_task(
}
}
/// The task that handles the [`RoomSendQueueUpdate`]s.
/// Long-lived task that forwards [`RoomSendQueueUpdate`]s (local echoes) to the
/// timeline.
pub(in crate::timeline) async fn room_send_queue_update_task(
mut send_queue_stream: Receiver<RoomSendQueueUpdate>,
timeline_controller: TimelineController,