Module yrs::types

Re-exports

pub use map::Map;

pub use text::Text;

Modules

array

map

text

xml

Structs

Branch

Branch describes a content of a complex Yrs data structures, such as arrays or maps.

BranchPtr

A wrapper around Branch cell, supplied with a bunch of convenience methods to operate on both map-like and array-like contents of a Branch.

Events

EventsIter

Enums

Change

A single change done over an array-component of shared data type.

Delta

A single change done over a text-like types: Text or XmlText.

EntryChange

A single change done over a map-component of shared data type.

Event

Generalized wrapper around events fired by specialized shared data types.

PathSegment

A single segment of a Path.

Value

Value that can be returned by Yrs data types. This includes Any which is an extension representation of JSON, but also nested complex collaborative structures specific to Yrs.

Constants

TYPE_REFS_ARRAY

Type ref identifier for an Array type.

TYPE_REFS_MAP

Type ref identifier for a Map type.

TYPE_REFS_TEXT

Type ref identifier for a Text type.

TYPE_REFS_UNDEFINED

Placeholder type ref identifier for non-specialized AbstractType. Used only for root-level types which have been integrated from remote peers before they were defined locally.

TYPE_REFS_XML_ELEMENT

Type ref identifier for a XmlElement type.

TYPE_REFS_XML_FRAGMENT

Type ref identifier for a [XmlFragment] type. Used for compatibility.

TYPE_REFS_XML_HOOK

Type ref identifier for a [XmlHook] type. Used for compatibility.

TYPE_REFS_XML_TEXT

Type ref identifier for a XmlText type.

Traits

DeepObservable

Trait implemented by all Y-types, allowing for observing events which are emitted by nested types.

Type Definitions

Attrs

An alias for map of attributes used as formatting parameters by Text and XmlText types.

Path

A path describing nesting structure between shared collections containing each other. It’s a collection of segments which refer to either index (in case of Array or XmlElement) or string key (in case of Map) where successor shared collection can be found within subsequent parent types.

TypeRefs