PhantomData in structs to prevent outside instantiation #172
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
added 4 commits
November 15, 2024 12:34
This prevents code outside of the crate from
constructing the given structs using a StructExpression
(i.e., MyStruct { ... }). I have tested and confirmed
that, for example, I cannot instatiate a struct from
the fastsim-cli crate. This was deemed to be a little
less convoluted than using a PhantomData typed method
which essentially does the same thing.
calbaker
approved these changes
Dec 9, 2024
There was a problem hiding this comment.
Note: I ended up using the #[non_exhaustive] meta word syntax as it does prevent Struct Instantiation outside of the crate (e.g., I tested from fastsim-cli and the compiler would not let me struct instantiate).
@michael-okeefe I came here to ask this very question and you preempted me! Nice work!
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.
Addresses:
https://github.nrel.gov/MBAP/fastsim/issues/362
Note: I ended up using the
#[non_exhaustive]meta word syntax as it does prevent Struct Instantiation outside of the crate (e.g., I tested from fastsim-cli and the compiler would not let me struct instantiate).