Struct TreeHandler

pub struct TreeHandler { /* private fields */ }

Implementations

impl TreeHandler

pub fn new_detached() -> Self

Create a new container that is detached from the document.

The edits on a detached container will not be persisted/synced. To attach the container to the document, please insert it into an attached container.

pub fn delete(&self, target: TreeID) -> LoroResult<()>

pub fn create(&self, parent: TreeParentId) -> LoroResult<TreeID>

pub fn create_at( &self, parent: TreeParentId, index: usize, ) -> LoroResult<TreeID>

pub fn mov(&self, target: TreeID, parent: TreeParentId) -> LoroResult<()>

pub fn mov_after(&self, target: TreeID, other: TreeID) -> LoroResult<()>

pub fn mov_before(&self, target: TreeID, other: TreeID) -> LoroResult<()>

pub fn move_to( &self, target: TreeID, parent: TreeParentId, index: usize, ) -> LoroResult<()>

pub fn get_meta(&self, target: TreeID) -> LoroResult<MapHandler>

pub fn is_node_unexist(&self, target: &TreeID) -> bool

pub fn is_node_deleted(&self, target: &TreeID) -> LoroResult<bool>

pub fn get_node_parent(&self, target: &TreeID) -> Option<TreeParentId>

Get the parent of the node, if the node does not exist, return None

pub fn children(&self, parent: &TreeParentId) -> Option<Vec<TreeID>>

pub fn children_num(&self, parent: &TreeParentId) -> Option<usize>

pub fn contains(&self, target: TreeID) -> bool

Check if the node is exist. include deleted node.

pub fn get_child_at( &self, parent: &TreeParentId, index: usize, ) -> Option<TreeID>

pub fn is_parent(&self, target: &TreeID, parent: &TreeParentId) -> bool

pub fn nodes(&self) -> Vec<TreeID>

Get all nodes in the tree, including deleted nodes

pub fn get_nodes_under(&self, parent: TreeParentId) -> Vec<TreeNode>

pub fn roots(&self) -> Vec<TreeID>

pub fn get_all_hierarchy_nodes_under( &self, parent: TreeParentId, ) -> Vec<TreeNodeWithChildren>

pub fn __internal__next_tree_id(&self) -> TreeID

pub fn get_index_by_tree_id(&self, target: &TreeID) -> Option<usize>

Get the index of the target node in the parent node

O(logN)

pub fn get_position_by_tree_id( &self, target: &TreeID, ) -> Option<FractionalIndex>

pub fn is_fractional_index_enabled(&self) -> bool

pub fn enable_fractional_index(&self, jitter: u8)

Set whether to generate fractional index for Tree Position. The LoroDoc is set to use jitter 0 by default.

The jitter is used to avoid conflicts when multiple users are creating the node at the same position. value 0 is default, which means no jitter, any value larger than 0 will enable jitter.

Generally speaking, jitter will affect the growth rate of document size. Read more about it

pub fn disable_fractional_index(&self)

Disable the fractional index generation for Tree Position when you don’t need the Tree’s siblings to be sorted. The fractional index will be always default.

The LoroDoc is set to disable fractional index by default.

pub fn is_deleted(&self) -> bool

pub fn is_empty(&self) -> bool

pub fn get_last_move_id(&self, target: &TreeID) -> Option<ID>

pub fn clear(&self) -> LoroResult<()>

Trait Implementations

impl Clone for TreeHandler

fn clone(&self) -> TreeHandler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreeHandler

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

Formats the value using the given formatter.

impl HandlerTrait for TreeHandler

fn to_handler(&self) -> Handler

fn attach( &self, txn: &mut Transaction, parent: &BasicHandler, self_id: ContainerID, ) -> LoroResult<Self>

This method returns an attached handler.

fn is_attached(&self) -> bool

fn attached_handler(&self) -> Option<&BasicHandler>

fn get_value(&self) -> LoroValue

fn get_deep_value(&self) -> LoroValue

fn kind(&self) -> ContainerType

fn get_attached(&self) -> Option<Self>

If a detached container is attached, this method will return its corresponding attached handler.

fn from_handler(h: Handler) -> Option<Self>

fn doc(&self) -> Option<LoroDoc>

fn parent(&self) -> Option<Handler>

fn idx(&self) -> ContainerIdx

fn id(&self) -> ContainerID

fn with_state<R>( &self, f: impl FnOnce(&mut State) -> LoroResult<R>, ) -> LoroResult<R>