Struct SchemaDoc 

pub struct SchemaDoc { /* private fields */ }

Loro-backed CRDT document tracking a single array’s schema.

The schema is stored as a MessagePack blob at root map key "content". schema_hlc is the HLC of the most-recent schema write on this replica; it is compared against the schema_hlc embedded in each [ArrayOp] header to gate op application.

LoroDoc is not Clone, so SchemaDoc is not Clone either.

Implementations

impl SchemaDoc

pub fn new(replica_id: ReplicaId) -> Self

Create an empty schema doc for replica_id.

schema_hlc starts at Hlc::ZERO. Call SchemaDoc::from_schema or SchemaDoc::import_snapshot to populate it.

pub fn from_schema( replica_id: ReplicaId, schema: &ArraySchema, generator: &HlcGenerator, ) -> ArrayResult<Self>

Construct a schema doc pre-populated with schema.

The schema is encoded as MessagePack and stored under root["content"]. generator.next() is called to assign the initial schema_hlc.

pub fn schema_hlc(&self) -> Hlc

Return the current schema HLC.

pub fn replica_id(&self) -> ReplicaId

Return the replica ID of this doc.

pub fn to_schema(&self) -> ArrayResult<ArraySchema>

Decode the stored schema from the Loro doc.

Reads the MessagePack blob at root["content"] and decodes it via zerompk. Errors map to ArrayError::SegmentCorruption.

pub fn export_snapshot(&self) -> ArrayResult<Vec<u8>>

Export the full Loro snapshot as an enveloped byte buffer.

The returned bytes have the format: [LORO_FORMAT_VERSION: u8][loro snapshot bytes…]

Pass the result to SchemaDoc::import_snapshot (or SchemaDoc::import_snapshot_replicated) on another replica to converge schema state.

pub fn import_snapshot( &mut self, bytes: &[u8], remote_hlc: Hlc, generator: &HlcGenerator, ) -> ArrayResult<()>

Import a Loro snapshot from a remote replica.

After merging the snapshot, generator.observe(remote_hlc) is called so the local generator incorporates the remote clock. A fresh schema_hlc is then generated via generator.next() so that any subsequent local writes have an HLC strictly greater than remote_hlc.

pub fn import_snapshot_replicated( &mut self, bytes: &[u8], committed_hlc: Hlc, ) -> ArrayResult<()>

Import a Loro snapshot from a Raft-committed entry.

Unlike [import_snapshot], this method sets schema_hlc to exactly remote_hlc rather than bumping past it. This is the correct behaviour for Raft replication: every replica must converge to the same schema_hlc after applying the same log entry so that schema-gating checks on ops are consistent across the cluster.

Call this only from the distributed applier (Raft commit path), not from the CRDT sync path where bumping is required.

pub fn replace_schema( &mut self, schema: &ArraySchema, generator: &HlcGenerator, ) -> ArrayResult<()>

Replace the stored schema with schema.

Re-encodes the schema as MessagePack and overwrites root["content"]. Bumps schema_hlc via generator.next().

This is the stub entry point for Phase F ALTER ARRAY support. Incremental dim/attr add will build on this path.