mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-12 01:45:29 -04:00
Code Issues Packages Projects Releases Wiki Activity

doc(event cache): tweak paginate_backwards_with_network doc comment

Browse Source
This commit is contained in:
Benjamin Bouvier
2025-02-26 12:17:37 +01:00
parent 2e1b051a4d
commit 1feb77bbef
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
crates/matrix-sdk/src/event_cache/pagination.rs
View File

@@ -212,10 +212,10 @@ impl RoomPagination {
/// Run a single pagination request (/messages) to the server.
///
/// If there's no previous-batch token, it will wait for one for a short
/// while to get one, or if it's already done so or seen a
/// previous-batch token before, it will immediately indicate
/// it's reached the end of the timeline.
/// If there are no previous-batch tokens, it will wait for one for a short
/// while to get one, or if it's already done so or if it's seen a
/// previous-batch token before, it will immediately indicate it's
/// reached the end of the timeline.
async fn paginate_backwards_with_network(
&self,
batch_size: u16,
@@ -262,9 +262,11 @@ impl RoomPagination {
if gap_id.is_none() {
// We got a previous-batch token from the linked chunk *before* running the
// request, which is missing from the linked chunk *after* completing the
// request. It may be a sign the linked chunk has been reset,
// and it's an error in any case.
// request, but it is missing *after* completing the
// request.
//
// It may be a sign the linked chunk has been reset, but it's fine, per this
// function's contract.
return Ok(None);
}