mirrors/loro
1
0
Fork 0
mirror of https://github.com/loro-dev/loro.git synced 2025-01-22 21:07:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update find pos doc

Browse source
This commit is contained in:
Zixuan Chen 2022-10-10 16:53:12 +08:00
parent 92a2e48ef5
commit 944d60bfe9
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
crates/rle/src/rle_tree/tree_trait.rs
View file

@ -77,6 +77,7 @@ pub trait RleTreeTrait<T: Rle>: Sized + Debug {
/// - `child_index` can only equal to children.len() when index out of range
/// - We need the `offset` so we can perform `find_pos_internal(child, new_search_index)`.
/// - We need the `pos` to determine whether the child is included or excluded
/// - If index is at the end of an element, `found` should be true
/// - If not found, then `found` should be false and `child_index` should be the index of the insert position
fn find_pos_internal(
node: &InternalNode<'_, T, Self>,
@ -87,6 +88,7 @@ pub trait RleTreeTrait<T: Rle>: Sized + Debug {
/// - if `pos == Middle`, we need to split the node
/// - We need the third arg to determine whether the child is included or excluded
/// - If not found, then `found` should be false and `child_index` should be the index of the insert position
/// - If index is at the end of an element, `found` should be true
/// - If target index is after last child, then `child_index` = children.len().wrapping_sub(1), `offset` = children.last().unwrap().len()
fn find_pos_leaf(node: &LeafNode<'_, T, Self>, index: Self::Int) -> FindPosResult<usize>;