Add interner lifetime and improve documentation #76
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 commit adds 'i lifetime that can be used by backends to return &'i str when it's known that the backing string storage won't be moved. This is the case for fixed capacity pool-like backends and backends which avoid backing buffer moves via double indirection. Signed-off-by: Tin Švagelj <[email protected]>
Signed-off-by: Tin Švagelj <[email protected]>
Caellian
changed the title
|
New comparison table looks like: light
dark
ayu
I've also described how each backend actually works - until now I believed |
|
Something I didn't foresee while creating this PR is that BucketBackend is effectively a backend which doesn't have to move its contents. It's currently implemented using |
- Move comparison table to a separate section. - Use CSS icons to make table more readable. - Refer to the table from backend documentations. - Explain how backends store and manipulate interned data. Signed-off-by: Tin Švagelj <[email protected]>
Signed-off-by: Tin Švagelj <[email protected]>
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.
This commit adds 'i lifetime that can be used by backends to return &'i str when it's known that the backing string storage won't be moved.
This is the case for fixed capacity pool-like backends and backends which avoid backing buffer moves via double indirection.
StringInterner::resolvecan now return&'i strfor backends that support it, or a local (call-site bound) reference. The local reference prevents insertions intoStringInternerdue to XOR mutability, while&'i strdoesn't.This is related to #75.
TODO
'ilifetimeBucketBackendso it's capable of resolving to&'i str.