This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
Improve the two Interface pointers #125
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
snf
approved these changes
Feb 18, 2020
| /// | ||
| /// # Panics | ||
| /// | ||
| /// Panics if `ptr` is null | ||
| pub unsafe fn new(ptr: *mut *mut <T as ComInterface>::VTable) -> InterfacePtr<T> { | ||
| InterfacePtr { | ||
| ptr: NonNull::new(ptr).expect("ptr was null"), | ||
| ptr: NonNull::new(ptr).expect("InterfacePtr's ptr was null"), |
There was a problem hiding this comment.
I recon this was the previous behavior. Is it better to return an option rather than crashing?
There was a problem hiding this comment.
Not blocking on this though. Feel free to merge it
There was a problem hiding this comment.
I'd be fine with that. I can make that change
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 addresses most of the issues in #99.
InterfacePtrshould only be constructed ifAddRefwas called on the underlying interface before the raw pointer is moved intoInterfacePtr::new. The documentation ofInterfacePtr::newnow reflects this. It is up to the user to ensure thatReleasegets called when thatInterfacePtris no longer needed. This is usually done by convertingInterfacePtrto anInterfaceRcthrough theInterfacePtr::upgrademethod.These changes make it possible to leak memory but not to violate safety rules unless some invariant is not held when calling an
unsafefunction.Clone on
InterfacePtrnow correctly callsadd_refto ensure that the invariant ofAddRefbeing called beforeInterfacePtr::newis constructed is upheld.