feat(ffi): add OwnedString class #438
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
JP-Ellis
added
type:feature
JP-Ellis
force-pushed
the
feat/owned-string
branch
from
9512c59
to
edca6ff
Compare
A number of FFI functions return strings that are owned by the library and must be freed manually. Unfortunately, returning a `str` from a function would result in a memory leak, as the Python runtime would not know to free the string. This commit adds an `OwnedString` class that wraps a `str` and a function that frees the string. The `__del__` method of the class calls the free function, ensuring that the string is freed when the object is garbage collected. Signed-off-by: JP-Ellis <josh@jpellis.me>
JP-Ellis
force-pushed
the
feat/owned-string
branch
from
edca6ff
to
49bc358
Compare
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.
📝 Summary
OwnedStringclass🚨 Breaking Changes🔥 Motivation
A number of FFI functions return strings that are owned by the library and must be freed manually. Unfortunately, returning a
strfrom a function would result in a memory leak, as the Python runtime would not know to free the string.This commit adds an
OwnedStringclass that wraps astrand a function that frees the string. The__del__method of the class calls the free function, ensuring that the string is freed when the object is garbage collected.🔨 Test Plan
🔗 Related issues/PRs
OwnedStringto FFI #437