Struct loro_internal::oplog::OpLog

pub struct OpLog { /* private fields */ }

OpLog store all the ops i.e. the history. It allows multiple [AppState] to attach to it. So you can derive different versions of the state from the OpLog. It allows us to build a version control system.

The causal graph should always be a DAG and complete. So we can always find the LCA. If deps are missing, we can’t import the change. It will be put into the pending_changes.

Implementations

impl OpLog

pub fn new() -> Self

pub fn new_with_arena(arena: SharedArena) -> Self

pub fn latest_timestamp(&self) -> Timestamp

pub fn dag(&self) -> &AppDag

pub fn get_timestamp_of_version(&self, f: &Frontiers) -> Timestamp

pub fn is_empty(&self) -> bool

pub fn changes(&self) -> &FxHashMap<PeerID, Vec<Change>>

pub fn import_local_change( &mut self, change: Change, from_txn: bool ) -> Result<(), LoroError>

Import a change.

Pending changes that haven’t been applied to the dag. A change can be imported only when all its deps are already imported. Key is the ID of the missing dep

Err

• Return Err(LoroError::UsedOpID) when the change’s id is occupied
• Return Err(LoroError::DecodeError) when the change’s deps are missing

pub fn next_lamport(&self) -> Lamport

pub fn next_id(&self, peer: PeerID) -> ID

pub fn get_peer_changes(&self, peer: PeerID) -> Option<&Vec<Change>>

pub fn cmp_frontiers(&self, other: &Frontiers) -> Ordering

• Ordering::Less means self is less than target or parallel
• Ordering::Equal means versions equal
• Ordering::Greater means self’s version is greater than target

pub fn get_change_at(&self, id: ID) -> Option<&Change>

pub fn get_remote_change_at(&self, id: ID) -> Option<Change<RemoteOp<'_>>>

pub fn export_from(&self, vv: &VersionVector) -> Vec<u8>

pub fn decode(&mut self, data: &[u8]) -> Result<(), LoroError>

pub fn diagnose_size(&self) -> SizeInfo

Trait Implementations

impl Clone for OpLog

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpLog

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

Formats the value using the given formatter.

impl Default for OpLog

fn default() -> Self

Returns the “default value” for a type.