Struct loro_internal::DocState

source ·
pub struct DocState { /* private fields */ }

Implementations§

source§

impl DocState

source

pub fn new_arc( arena: SharedArena, global_txn: Weak<Mutex<Option<Transaction>>>, config: Configure ) -> Arc<Mutex<Self>>

source

pub fn start_recording(&mut self)

source

pub fn stop_and_clear_recording(&mut self)

source

pub fn is_recording(&self) -> bool

source

pub fn refresh_peer_id(&mut self)

source

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

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

source

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

source

pub fn peer_id(&self) -> PeerID

source

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

source

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

source

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

source

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

source

pub fn is_empty(&self) -> bool

source

pub fn get_deep_value(&mut self) -> LoroValue

source

pub fn get_deep_value_with_id(&mut self) -> LoroValue

source

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

source

pub fn log_estimated_size(&self)

source

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

source

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

source

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

Trait Implementations§

source§

impl Clone for DocState

source§

fn clone(&self) -> DocState

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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