Module sync
Modules§
Structs§
- Awareness
- The Awareness class implements a simple shared state protocol that can be used for non-persistent data like awareness information (cursor, username, status, ..). Each client can update its own local state and listen to state changes of remote clients.
- Awareness
Update - A structure that represents an encodable state of an Awareness struct.
- Default
Protocol - A default implementation of y-sync Protocol.
- Message
Reader - Since y-sync protocol enables for a multiple messages to be packed into a singe byte payload, MessageReader can be used over the decoder to read these messages one by one in iterable fashion.
Enums§
- Error
- An error type returned in response from y-sync Protocol.
- Message
- Sync
Message
Traits§
- Clock
- A clock trait used to obtain the current time.
- Protocol
- Trait implementing a y-sync protocol. The default implementation can be found in DefaultProtocol, but its implementation steps can be potentially changed by the user if necessary.
Type Aliases§
- Timestamp
- Timestamp used by crate::sync::Awareness to tag most recent updates.