Structs§
- Describes a consecutive range of updates (identified by their IDs).
- Block identifier, which allows to uniquely identify any element insertion in a global scope (across different replicas of the same document). It consists of client ID (which is a unique document replica identifier) and monotonically incrementing clock value.
- Block defines a range of consecutive updates performed by the same peer. While individual updates are always uniquely defined by their corresponding IDs, they may contain a lot of additional metadata. Block representation here is crucial, since it optimizes memory usage, available when multiple updates have been performed one after another (eg. when user is writing a sentence, individual key strokes are independent updates but they can be compresses into a single block containing an entire sentence for as long as another piece of data is not being inserted in the middle it).
- Empty type marker, which can be used by a Prelim trait implementations when no integrated value should be returned after prelim type has been integrated as a result of insertion.
Enums§
- Prelim container for types passed over to Text::insert_embed and Text::insert_embed_with_attributes methods.
- An enum describing the type of a user data content stored as part of one or more (if items were squashed) insert operations.
Constants§
- Bit flag used to identify [Item::GC].
- Bit flag used to identify items with content of type ItemContent::Any.
- Bit flag used to identify items with content of type ItemContent::Binary.
- Bit flag used to identify items with content of type ItemContent::Deleted.
- Bit flag used to identify items with content of type ItemContent::Doc.
- Bit flag used to identify items with content of type ItemContent::Embed.
- Bit flag used to identify items with content of type ItemContent::Format.
- Bit flag used to identify items with content of type ItemContent::JSON.
- Bit flag used to identify items with content of type ItemContent::Move.
- Bit flag used to identify items with content of type ItemContent::String.
- Bit flag used to identify items with content of type [ItemContent::Number].
- Bit flag used to identify [Item::Skip].
- Bit flag used to tell if encoded item has left origin defined.
- Bit flag used to tell if encoded item has a parent subtitle defined. Subtitles are used only for blocks which act as map-like types entries.
- Bit flag used to tell if encoded item has right origin defined.
Traits§
- A trait used for preliminary types, that can be inserted into shared Yrs collections.
Type Aliases§
- Globally unique client identifier. No two active peers are allowed to share the same ClientID. If that happens, following updates may cause document store to be corrupted and desync in a result.