matrix_sdk/sliding_sync/list/
sticky.rs

1use ruma::{api::client::sync::sync_events::v5 as http, events::StateEventType};
2
3use crate::sliding_sync::sticky_parameters::StickyData;
4
5/// The set of `SlidingSyncList` request parameters that are *sticky*, as
6/// defined by the [Sliding Sync MSC](https://github.com/matrix-org/matrix-spec-proposals/blob/kegan/sync-v3/proposals/3575-sync.md).
7#[derive(Debug)]
8pub(super) struct SlidingSyncListStickyParameters {
9    /// Required states to return per room.
10    required_state: Vec<(StateEventType, String)>,
11
12    /// Any filters to apply to the query.
13    filters: Option<http::request::ListFilters>,
14}
15
16impl SlidingSyncListStickyParameters {
17    pub fn new(
18        required_state: Vec<(StateEventType, String)>,
19        filters: Option<http::request::ListFilters>,
20    ) -> Self {
21        // Consider that each list will have at least one parameter set, so invalidate
22        // it by default.
23        Self { required_state, filters }
24    }
25}
26
27impl StickyData for SlidingSyncListStickyParameters {
28    type Request = http::request::List;
29
30    fn apply(&self, request: &mut Self::Request) {
31        request.room_details.required_state = self.required_state.to_vec();
32        request.filters = self.filters.clone();
33    }
34}