publicly expose the capability module
#512
Open
Conversation
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
The `CapabilityTrait` trait is part of the public API of `timely` (e.g `OutputHandle::session` expects one, but the trait itself is not publicly accessible. This is because implementing this trait would circumvent the safety properties of capabilities. However, not exposing it also prevents safe wrapping of handles to provide additional functionality on top of them. This PR offers a solution by making the `capability` module public and using the [sealed trait pattern](https://rust-lang.github.io/api-guidelines/future-proofing.html) to prevent any foreign crate from implementing `CapabilityTrait`. Signed-off-by: Petros Angelatos <[email protected]>
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
CapabilityTraittrait is part of the public API oftimely(e.gOutputHandle::sessionexpects one), but the trait itself is not publicly accessible.This is because implementing this trait would circumvent the safety properties of capabilities. However, not exposing it also prevents safe wrapping of handles to provide additional functionality on top of them.
This PR offers a solution by making the
capabilitymodule public and using the sealed traitpattern to prevent any foreign crate from implementing
CapabilityTrait.