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

doc(sdk): Improve documentation of SlidingSyncMode.

Browse Source
This commit is contained in:
Ivan Enderlin
2023-02-22 16:51:42 +01:00
parent 1469e9033c
commit dec4b2122b
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -690,11 +690,13 @@ pub enum SlidingSyncState {
/// The mode by which the the [`SlidingSyncView`] is in fetching the data.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum SlidingSyncMode {
/// fully sync all rooms in the background, page by page of `batch_size`
/// Fully sync all rooms in the background, page by page of `batch_size`,
/// like `0..20`, `21..40`, 41..60` etc. assuming the `batch_size` is 20.
#[serde(alias = "FullSync")]
PagingFullSync,
/// fully sync all rooms in the background, with a growing window of
/// `batch_size`,
/// Fully sync all rooms in the background, with a growing window of
/// `batch_size`, like `0..20`, `0..40`, `0..60` etc. assuming the
/// `batch_size` is 20.
GrowingFullSync,
/// Only sync the specific windows defined
#[default]