fix(sdk): Various tiny improvements for LinkedChunk
#3236
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch is about an internal thing, but it makes the code easier to understand.
This patch implements the new `LinkedChunk::items` method that returns a forward iterator over items.
This patch implements `From<ChunkIdentifier>` for `ItemPosition`. It's useful when we get a `ChunkIdentifier` and we need to `insert_… _at(item_position)`.
This patch implements `Chunk::content` to get an immutable reference to the content of a chunk.
This patch implements `Copy` and `Clone` for `ItemPosition`.
This patch implements the `LinkedChunk::chunks` method that returns a forward iterator over the chunks.
This patch adds the new `Chunk::as_ptr` method. It simplifies the code a little bit.
This patch rewrites `LinkedChunk::replace_gap_at`. Instead of inserting new items on the _previous_ chunk of the gap and doing all the stuff here, a new items chunk is created _after_ the gap (where items are pushed), to finally unlink and remove the gap. First off, it removes an `unwrap`. Second, if the previous chunk was an items chunk, and had free space, the items would have been added in there, which is not the intended behaviour. The tests have been updated accordingly.
Hywan
force-pushed
the
feat-sdk-event-cache-linked-chunk-various-improvements
branch
from
8b2ff8a to
06e212c
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3236 +/- ##
=======================================
Coverage 83.66% 83.66%
=======================================
Files 236 236
Lines 24402 24429 +27
=======================================
+ Hits 20416 20439 +23
- Misses 3986 3990 +4 ☔ View full report in Codecov by Sentry. |
This patch implements `Chunk::first_item_position` and `Chunk::last_item_position` as a way to _position_ the “cursor” (`ItemPosition`) in the correct way when we want to do some particular insertion (at the beginning or at the end of a chunk).
This patch optimises `LinkedChunk::rchunks` and `chunks` by _not_ using `rchunks_from` and `chunks_from`. Indeed, it's faster to not call the inner `chunk` method + `unwrap`ping the result and so on. Just a tiny optimisation. This patch also uses the new `Chunk::last_item_position` method for `LinkedChunk::items`. Abstraction for the win!
Previously, in a chunk with items `a`, `b` and `c`, their indices were 2, 1 and 0. It creates a problem when we push new items: all indices must be shifted to the left inside the same chunk. That's not optimised. This patch reverses the order, thus now `a` has index 0, `b` has index 1 and `c` has index 2. It also removes a possible bug where we use `item_index` without “reversing” it. This is now obvious that we don't need to re-compute the `item_index`, we can use it directly.
3 tasks
The “position” can be placed inside a `Gap`, so naming it `Item…` is a non-sense. This patch removes the `Item` prefix.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Those patches have been cherry-picked from #3230. It's a collection of tiny improvements or bug fixes for
LinkedChunk. More have been added after that. It's best to review them one by one.