Improve documentation on how to correctly free memory and free memory in tests#33
Merged
tenderlove merged 1 commit intoruby:masterfrom May 18, 2020
Merged
Improve documentation on how to correctly free memory and free memory in tests#33tenderlove merged 1 commit intoruby:masterfrom
tenderlove merged 1 commit intoruby:masterfrom
Conversation
chrisseaton
commented
May 18, 2020
| # MyStruct = Fiddle::CStructBuilder.create(Fiddle::CUnion, types, members) | ||
| # | ||
| # obj = MyStruct.allocate | ||
| # obj = MyStruct.malloc |
Contributor
Author
There was a problem hiding this comment.
I don't think allocate was ever correct?
Member
|
Adding the block API makes sense to me |
This file contains hidden or 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
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.
The documentation for pointers and structs doesn't include as much helpful information as it could about who is responsible for freeing memory and how to do it safely. I've added some specific examples for guidance.
I've then also applied this in the test suite, which I think was not freeing memory in many tests.
Or am I misunderstanding how freeing pointers and structs works in Fiddle?
If I'm understanding it all correctly, I'd then like to follow this up with some additions to the API to make it even easier to do the right thing, such as