Struct SharedArena 

pub struct SharedArena { /* private fields */ }

This is shared between [OpLog] and [AppState].

Implementations

impl SharedArena

pub fn new() -> Self

pub fn fork(&self) -> Self

pub fn register_container(&self, id: &ContainerID) -> ContainerIdx

pub fn get_container_id(&self, idx: ContainerIdx) -> Option<ContainerID>

pub fn id_to_idx(&self, id: &ContainerID) -> Option<ContainerIdx>

Fast map from ContainerID to ContainerIdx for containers already registered in the arena.

Important: This is not an existence check. Absence here does not imply that a container does not exist, since registration can be lazy and containers may be persisted only in the state KV store until first use.

For existence-aware lookup that consults persisted state and performs lazy registration, prefer DocState::resolve_idx.

pub fn idx_to_id(&self, id: ContainerIdx) -> Option<ContainerID>

pub fn with_idx_to_id<R>(&self, f: impl FnOnce(&Vec<ContainerID>) -> R) -> R

pub fn alloc_str(&self, str: &str) -> StrAllocResult

pub fn alloc_str_with_slice(&self, str: &str) -> (BytesSlice, StrAllocResult)

return slice and unicode index

pub fn alloc_str_fast(&self, bytes: &[u8])

alloc str without extra info

pub fn utf16_len(&self) -> usize

pub fn alloc_value(&self, value: LoroValue) -> usize

pub fn alloc_values( &self, values: impl Iterator<Item = LoroValue>, ) -> Range<usize>

pub fn set_parent(&self, child: ContainerIdx, parent: Option<ContainerIdx>)

pub fn log_hierarchy(&self)

pub fn log_all_containers(&self)

pub fn get_parent(&self, child: ContainerIdx) -> Option<ContainerIdx>

pub fn with_ancestors( &self, container: ContainerIdx, f: impl FnMut(ContainerIdx, bool), )

Call f on each ancestor of container, including container itself.

f(ContainerIdx, is_first)

pub fn slice_by_unicode(&self, range: impl RangeBounds<usize>) -> BytesSlice

pub fn slice_by_utf8(&self, range: impl RangeBounds<usize>) -> BytesSlice

pub fn slice_str_by_unicode_range(&self, range: Range<usize>) -> String

pub fn with_text_slice(&self, range: Range<usize>, f: impl FnMut(&str))

pub fn get_value(&self, idx: usize) -> Option<LoroValue>

pub fn get_values(&self, range: Range<usize>) -> Vec<LoroValue>

pub fn convert_single_op( &self, container: &ContainerID, peer: PeerID, counter: Counter, lamport: Lamport, content: RawOpContent<'_>, ) -> Op

pub fn can_import_snapshot(&self) -> bool

pub fn convert_raw_op(&self, op: &RawOp<'_>) -> Op

pub fn export_containers(&self) -> Vec<ContainerID>

pub fn export_parents(&self) -> Vec<Option<ContainerIdx>>

impl SharedArena

pub fn set_parent_resolver<F>(&self, resolver: Option<F>)

where F: Fn(ContainerID) -> Option<ContainerID> + Send + Sync + 'static,

Register or clear a resolver to lazily determine a container’s parent when missing.

• The resolver receives the child ContainerIdx and returns an optional ContainerID of its parent.
• If the resolver returns Some, SharedArena will register the parent in the arena and link it.
• If the resolver is None or returns None, get_parent will panic for non-root containers as before.

Trait Implementations

impl Clone for SharedArena

fn clone(&self) -> SharedArena

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SharedArena

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

Formats the value using the given formatter.