Struct Connection 

pub struct Connection {
    pub globalsince: u64,
    pub next_batch: u64,
    pub lists: Lists,
    pub extensions: Extensions,
    pub subscriptions: Subscriptions,
    pub rooms: Rooms,
    pub own_profile_since: u64,
    pub profiles_fields_widened: bool,
}

What a sliding sync connection carries from one request to the next.

It is stored after every response, so a client resuming from a position finds the lists, extension settings and per-room progress it left there.

Fields

globalsince: u64

next_batch: u64

lists: Lists

extensions: Extensions

subscriptions: Subscriptions

rooms: Rooms

own_profile_since: u64

Position of the response that last carried the syncing user’s whole profile in the MSC4262 profiles extension.

Zero until a response has carried it, and again whenever the extension is switched off, so switching it back on sends the whole profile anew.

profiles_fields_widened: bool

Whether the connection asked for a profile field it did not have before.

It rides the whole profile above, so the rooms replay their slice of the change log until the client advances past the response carrying the widened field set, and it is forgotten with everything else the extension owes when the extension goes off.

Implementations

impl Connection

pub fn store(&self, service: &Service, key: &ConnectionKey)

impl Connection

pub fn update_rooms_prologue(&mut self, retard_since: Option<u64>)

impl Connection

pub fn update_rooms_epilogue<'a, Complete>(&mut self, complete: Complete)

where Complete: Iterator<Item = (&'a RoomId, Option<RoomConfig>)> + Send + 'a,

Advance the per-room cursor for each complete bounded room range.

roomsince is the lower bound of every content query for its room. Only rooms whose complete range was safely assembled may advance. A failed room keeps its cursor and retries the same range after a later wake.

impl Connection

pub fn update_profiles_epilogue(&mut self)

Records that this pass carried the syncing user’s whole profile.

Called once the pass has assembled its extensions, so a pass that failed leaves the profile owed to the next one.

impl Connection

pub fn profiles_fields_owed(&self) -> bool

Whether a base is owed for a profile field the connection did not have before.

MSC4262 asks for the widened fields of every user in the room subset, which the room passes deliver by replaying their whole slice of the change log.

impl Connection

pub fn own_profile_owed(&self) -> bool

Whether the syncing user’s whole profile is owed to the profiles extension.

It is owed while the extension is on and the client has not acknowledged a response carrying it: the connection is new, the extension was switched on after the connection began, or the client is replaying from before the response that carried it.

impl Connection

pub fn update_cache(&mut self, request: &Request) -> bool

impl Connection

fn update_cache_lists(request: &Request, cached: &mut Self) -> bool

impl Connection

fn update_cache_list(request: &List, cached: &mut List) -> bool

impl Connection

fn update_cache_subscriptions(request: &Request, cached: &mut Self) -> bool

impl Connection

fn update_cache_extensions(request: &Request, cached: &mut Self) -> bool

Merges the request’s extension settings into the connection.

Returns whether the MSC4262 field filter named a field the connection did not have, which the profiles extension owes a base for.

impl Connection

fn update_cache_account_data(request: &AccountData, cached: &mut AccountData)

impl Connection

fn update_cache_receipts(request: &Receipts, cached: &mut Receipts)

impl Connection

fn update_cache_typing(request: &Typing, cached: &mut Typing)

impl Connection

fn update_cache_to_device(request: &ToDevice, cached: &mut ToDevice)

impl Connection

fn update_cache_profiles(request: &Profiles, cached: &mut Profiles) -> bool

Merges the profiles extension settings into the connection.

Returns whether the request widened the field filter, which is read before the merge overwrites the filter it compares against.

impl Connection

fn update_cache_e2ee(request: &E2EE, cached: &mut E2EE)

impl Connection

fn update_cache_profiles_owed(&mut self, fields_widened: bool)

Trait Implementations

impl Debug for Connection

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

Formats the value using the given formatter.

impl Default for Connection

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Connection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Connection

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.