Struct DocState

pub struct DocState { /* private fields */ }

Implementations

impl DocState

pub fn new_arc( doc: Weak<LoroDocInner>, arena: SharedArena, config: Configure, lock_group: &LoroLockGroup, ) -> Arc<LoroMutex<Self>>

pub fn fork_with_new_peer_id( &mut self, doc: Weak<LoroDocInner>, arena: SharedArena, config: Configure, ) -> Arc<Mutex<Self>>

pub fn start_recording(&mut self)

pub fn stop_and_clear_recording(&mut self)

pub fn is_recording(&self) -> bool

pub fn refresh_peer_id(&mut self)

pub fn take_events(&mut self) -> Vec<DocDiff>

Take all the diffs that are recorded and convert them to events.

pub fn set_peer_id(&mut self, peer: PeerID)

Change the peer id of this doc state. It changes the peer id for the future txn on this AppState

pub fn peer_id(&self) -> PeerID

pub fn apply_local_op(&mut self, raw_op: &RawOp<'_>, op: &Op) -> LoroResult<()>

pub fn iter_and_decode_all(&mut self) -> impl Iterator<Item = &mut State>

pub fn does_container_exist(&self, id: &ContainerID) -> bool

pub fn get_text<I: Into<ContainerIdRaw>>( &mut self, id: I, ) -> Option<&mut RichtextState>

id can be a str, ContainerID, or ContainerIdRaw. if it’s str it will use Root container, which will not be None

pub fn can_import_snapshot(&self) -> bool

pub fn get_value(&self) -> LoroValue

pub fn get_deep_value(&mut self) -> LoroValue

pub fn get_deep_value_with_id(&mut self) -> LoroValue

pub fn get_all_container_value_flat(&mut self) -> LoroValue

pub fn get_container_deep_value(&mut self, container: ContainerIdx) -> LoroValue

pub fn log_estimated_size(&self)

pub fn create_state(&self, idx: ContainerIdx) -> State

pub fn create_unknown_state(&self, idx: ContainerIdx) -> State

pub fn get_relative_position( &mut self, pos: &Cursor, use_event_index: bool, ) -> Option<usize>

pub fn get_value_by_path(&mut self, path: &[Index]) -> Option<LoroValue>

Trait Implementations

impl Debug for DocState

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

Formats the value using the given formatter.