Struct SyncData 

pub struct SyncData {
    pub global_account_data_events: Vec<SyncGlobalAccountDataEvent>,
    pub room_account_data_events: Vec<SyncRoomAccountDataEvent>,
    pub room_events: Vec<SyncEvent>,
    pub todevice_events: Vec<SyncToDeviceEvent>,
    pub changed_user_keys: Vec<ChangedUserKeys>,
    pub left_user_keys: Vec<OwnedUserId>,
    pub read_receipts: SyncRoomReceipts,
    pub federated_invites: Vec<(StreamId, FederatedInvite)>,
    pub federated_knocks: Vec<(StreamId, FederatedInvite)>,
}

This structure contains any data that needs to be synchronized.

Fields

global_account_data_events: Vec<SyncGlobalAccountDataEvent>

The global account data that needs to be synchronized.

room_account_data_events: Vec<SyncRoomAccountDataEvent>

The rooms account data events that needs to be synchronized.

room_events: Vec<SyncEvent>

The room events that need to be synchronized.

todevice_events: Vec<SyncToDeviceEvent>

The to-device events that needs to be synchronized.

changed_user_keys: Vec<ChangedUserKeys>

The list of users who either changed their keys or newly joined a room shared with the synchronizing user.

left_user_keys: Vec<OwnedUserId>

The list of users who either changed their keys or newly joined a room shared with the synchronizing user.

read_receipts: SyncRoomReceipts

The new and forward read receipts that were received since the last sync.

federated_invites: Vec<(StreamId, FederatedInvite)>

The invites the syncing user has received over federation

federated_knocks: Vec<(StreamId, FederatedInvite)>

The invites the syncing user has received over federation

Implementations

impl SyncData

async fn build_sync_response<'c>( self, transaction: &mut TransactedDb<'c>, user_id: &UserId, device_id: &DeviceId, sync_token: SyncToken, filter_definition: Option<&FilterDefinition>, ) -> Result<SyncResponse, InternalServerError>

Builds a SyncResponse from a pair of a SyncToken and some SyncData.

It also fetches any needed additional data from the transaction (e.g. events state history, etc)

async fn fetch_state_for_room<'c>( transaction: &mut TransactedDb<'c>, synced_room: &SyncedRoom, user_id: &UserId, room_id: &RoomId, sync_token: &SyncToken, ) -> Result<Vec<RoomEvent<Verified>>, InternalServerError>

Given a synced room, fill out the state field

If too many messages have been sent since the last /sync call, we need to still send all the state events that the user will miss when the returned timeline has a gap

If this is the first time this room is synced since we joined or were invited to the room, we also need to get the entire state of the room

Trait Implementations

impl Debug for SyncData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.