Skip to main content

SyncMessageType

nodedb_types::sync::wire::frame

Enum SyncMessageType

#[non_exhaustive]
#[repr(u8)]pub enum SyncMessageType {
Show 44 variants    Handshake = 1,
    HandshakeAck = 2,
    DeltaPush = 16,
    DeltaAck = 17,
    DeltaReject = 18,
    CollectionPurged = 20,
    ShapeSubscribe = 32,
    ShapeSnapshot = 33,
    ShapeDelta = 34,
    ShapeUnsubscribe = 35,
    VectorClockSync = 48,
    TimeseriesPush = 64,
    TimeseriesAck = 65,
    ResyncRequest = 80,
    Throttle = 82,
    TokenRefresh = 96,
    TokenRefreshAck = 97,
    DefinitionSync = 112,
    PresenceUpdate = 128,
    PresenceBroadcast = 129,
    PresenceLeave = 130,
    ArrayDelta = 144,
    ArrayDeltaBatch = 145,
    ArraySnapshot = 146,
    ArraySnapshotChunk = 147,
    ArraySchema = 148,
    ArrayAck = 149,
    ArrayReject = 150,
    ArrayCatchupRequest = 151,
    ColumnarInsert = 160,
    ColumnarInsertAck = 161,
    VectorInsert = 162,
    VectorInsertAck = 163,
    VectorDelete = 164,
    VectorDeleteAck = 165,
    FtsIndex = 166,
    FtsIndexAck = 167,
    FtsDelete = 168,
    FtsDeleteAck = 169,
    SpatialInsert = 170,
    SpatialInsertAck = 171,
    SpatialDelete = 172,
    SpatialDeleteAck = 173,
    PingPong = 255,
}

Expand description

Sync message type identifiers.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Handshake = 1

HandshakeAck = 2

DeltaPush = 16

DeltaAck = 17

DeltaReject = 18

CollectionPurged = 20

Collection purged notification (server → client, 0x14). Sent when an Origin collection is hard-deleted (UNDROP window expired or explicit DROP COLLECTION ... PURGE). The client must drop local Loro state and remove the collection’s redb record; future deltas for the collection are not sync-eligible.

ShapeSubscribe = 32

ShapeSnapshot = 33

ShapeDelta = 34

ShapeUnsubscribe = 35

VectorClockSync = 48

TimeseriesPush = 64

Timeseries metric batch push (client → server, 0x40).

TimeseriesAck = 65

Timeseries push acknowledgment (server → client, 0x41).

ResyncRequest = 80

Re-sync request (bidirectional, 0x50). Sent when sequence gaps or checksum failures are detected.

Throttle = 82

Downstream throttle (client → server, 0x52). Sent when Lite’s incoming queue is overwhelmed.

TokenRefresh = 96

Token refresh request (client → server, 0x60).

TokenRefreshAck = 97

Token refresh acknowledgment (server → client, 0x61).

DefinitionSync = 112

Definition sync (server → client, 0x70). Carries function/trigger/procedure definitions from Origin to Lite.

PresenceUpdate = 128

Presence update (client → server, 0x80).

PresenceBroadcast = 129

Presence broadcast (server → all subscribers except sender, 0x81).

PresenceLeave = 130

Presence leave (server → all subscribers, 0x82).

ArrayDelta = 144

Array CRDT delta (single op, client → server, 0x90).

ArrayDeltaBatch = 145

Array CRDT delta batch (multiple ops, client → server, 0x91).

ArraySnapshot = 146

Array snapshot header (server → client, 0x92).

ArraySnapshotChunk = 147

Array snapshot chunk (server → client, 0x93).

ArraySchema = 148

Array schema CRDT sync (bidirectional, 0x94).

ArrayAck = 149

Array ack — advances GC frontier (client → server, 0x95).

ArrayReject = 150

Array reject (server → client, 0x96). Compensation hint.

ArrayCatchupRequest = 151

Array catchup request (client → server, 0x97).

ColumnarInsert = 160

Columnar batch insert (client → server, 0xA0).

ColumnarInsertAck = 161

Columnar insert acknowledgment (server → client, 0xA1).

VectorInsert = 162

Vector insert (client → server, 0xA2).

VectorInsertAck = 163

Vector insert acknowledgment (server → client, 0xA3).

VectorDelete = 164

Vector delete (client → server, 0xA4).

VectorDeleteAck = 165

Vector delete acknowledgment (server → client, 0xA5).

FtsIndex = 166

FTS document index (client → server, 0xA6).

FtsIndexAck = 167

FTS index acknowledgment (server → client, 0xA7).

FtsDelete = 168

FTS document delete (client → server, 0xA8).

FtsDeleteAck = 169

FTS delete acknowledgment (server → client, 0xA9).

SpatialInsert = 170

Spatial geometry insert (client → server, 0xAA).

SpatialInsertAck = 171

Spatial insert acknowledgment (server → client, 0xAB).

SpatialDelete = 172

Spatial geometry delete (client → server, 0xAC).

SpatialDeleteAck = 173

Spatial delete acknowledgment (server → client, 0xAD).

PingPong = 255

Implementations§

impl SyncMessageType

pub fn from_u8(v: u8) -> Option<Self>

Trait Implementations§

impl Clone for SyncMessageType

fn clone(&self) -> SyncMessageType

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Copy for SyncMessageType

impl Debug for SyncMessageType

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

Formats the value using the given formatter. Read more

impl Eq for SyncMessageType

impl PartialEq for SyncMessageType

fn eq(&self, other: &SyncMessageType) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SyncMessageType

Auto Trait Implementations§

impl Freeze for SyncMessageType

impl RefUnwindSafe for SyncMessageType

impl Send for SyncMessageType

impl Sync for SyncMessageType

impl Unpin for SyncMessageType

impl UnsafeUnpin for SyncMessageType

impl UnwindSafe for SyncMessageType

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> LayoutRaw for T

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.

impl<T> Pointee for T

type Metadata = ()

The metadata type for pointers and references to this type.

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more