refactor: api module overhaul #540
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
Comment on lines
+132
to
+135
| let size = (stable_size() << 16) | ||
| .try_into() | ||
| .expect("overflow: stable memory too large to read in one go"); | ||
| let mut vec = Vec::with_capacity(size); |
There was a problem hiding this comment.
Could we use Result rather than panic in the interface here? The .expect(...) is up to us, and we could use Vec::try_with_capacity().
There was a problem hiding this comment.
The content of this src/stable.rs file was directly copied from src/api/stable/mod.rs.
I will improve the internal implementation in a later PR.
|
|
||
| let mut vec = self.memory.lock().unwrap(); | ||
| let previous_len = vec.len() as u64; | ||
| let new_len = vec.len() as u64 + new_bytes; |
There was a problem hiding this comment.
Suggested change
| let new_len = vec.len() as u64 + new_bytes; | |
| let new_len = previous_len + new_bytes; |
| /// size that was reserved. | ||
| /// | ||
| /// *Note*: Pages are 64KiB in WASM. | ||
| fn stable_grow(&self, new_pages: u64) -> Result<u64, StableMemoryError>; |
There was a problem hiding this comment.
I want to suggest calling the parameter additional_pages, which is unambiguous, but the public spec also uses new_pages.
Suggested change
| fn stable_grow(&self, new_pages: u64) -> Result<u64, StableMemoryError>; | |
| fn stable_grow(&self, additional_pages: u64) -> Result<u64, StableMemoryError>; |
|
I will improve the Providing migration guide / changelog / docs will be the last task in #521 before I make the first alpha release. |
ericswanson-dfinity
approved these changes
Dec 19, 2024
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.
Description
Overhaul the
apimodule. It now provides a complete binding for the system API. Stable memory API are moved intosrc/stable.rs.The bindings are named consistently. Please refer to the top documentation comments in
src/api.rsfor additional details.Existing bindings that are inconsistently named according to the new rules are now deprecated.
How Has This Been Tested?
Added
e2e-tests/tests/api.rs.e2e-tests/bin/api.rsillustrates how to use the API bindings.Checklist: