Change OrderedMap.Get() to return Value instead of Storable
#318
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 changes OrderedMap.Get() to return Value instead of Storable. Currently, OrderedMap.Get() returns Storable and client converts returned Storable to Value. However, it only makes sense to return Storable if client needs to remove register (slab) by StorageID (StorageIDStorable). Get() should only provide value without possibility of client manipulating the underlying storable.
fxamacker
added
improvement
breaking change
6 tasks
turbolent
approved these changes
Jun 28, 2023
There was a problem hiding this comment.
Nice! 👌
I checked Cadence and confirmed that it always converts the storable to a value anyways.
I also noticed that it uses Get for existence checks. Once atree starts to always convert to a value, this could become expensive in the case where the key exists: We would pay for a conversion and then the result is discarded. I opened onflow/cadence#2618 to improve / prevent that
fxamacker
added a commit
to onflow/cadence
that referenced
this pull request
Jun 29, 2023
This commit updates Cadence to use new Atree API - Array.Get() - OrderedMap.Get() - MaxInlineArrayElementSize() - MaxInlineMapKeySize() For more info, see Atree PRs: - onflow/atree#314 - onflow/atree#316 - onflow/atree#318
6 tasks
turbolent
pushed a commit
to onflow/cadence
that referenced
this pull request
Jan 26, 2024
This commit updates Cadence to use new Atree API - Array.Get() - OrderedMap.Get() - MaxInlineArrayElementSize() - MaxInlineMapKeySize() For more info, see Atree PRs: - onflow/atree#314 - onflow/atree#316 - onflow/atree#318
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.
Closes #317
Updates #296 #292
Description
This PR changes
OrderedMap.Get()to returnValueinstead ofStorable.Currently,
OrderedMap.Get()returnsStorableand client converts returnedStorabletoValue. However, it only makes sense to returnStorableif client needs to remove register (slab) byStorageID(StorageIDStorable).Get()should only provide value without possibility of client manipulating the underlying storable.This is prep work for Atree Register Inlining (#292) and will also harden the API.
Corresponding PR for
Array.Get()is PR #316.mainbranchFiles changedin the Github PR explorer