error-stack: move fmt::HookContext into hook::HookContext
#1693
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
github-actions
bot
added
the
area/libs > error-stack
Codecov Report
@@ Coverage Diff @@
## main #1693 +/- ##
==========================================
+ Coverage 55.95% 57.26% +1.30%
==========================================
Files 223 223
Lines 14935 15253 +318
Branches 380 380
==========================================
+ Hits 8357 8734 +377
+ Misses 6573 6514 -59
Partials 5 5
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
TimDiekmann
reviewed
Dec 19, 2022
Comment on lines
+170
to
+174
| pub fn cast<U>(&mut self) -> &mut HookContext<Extra, U> { | ||
| // SAFETY: `HookContext` is marked as repr(transparent) and the changed generic is only used | ||
| // inside of the `PhantomData` | ||
| unsafe { &mut *(self as *mut Self).cast::<HookContext<Extra, U>>() } | ||
| } |
There was a problem hiding this comment.
I take the opportunity to ask this question as we touched this code: Do you see a way to remove the unsafe here? I know, why we have, I'm just wondering if there is a way to avoid it (this question is unrelated to this PR).
There was a problem hiding this comment.
I don't think so, if we would instead transmute mut self instead we could use RFC 2528 may be of help.
TimDiekmann
approved these changes
Dec 20, 2022
trunk-io bot
pushed a commit
that referenced
this pull request
Jan 31, 2023
## 🌟 What is the purpose of this PR? #1693 separated `fmt::HookContext` into `hook::HookContext` and `fmt::HookContext`, so that it can be used in #1558. While working, the problem is that documentation doesn't render correctly because `hook::HookContext` is private in public. Therefore unreachable rustdoc is unable to navigate to the type, and the documentation is incomplete. This PR moves to a macro-based approach to enable better documentation. Instead of using an unreachable public type, we have a macro that implements the necessary common functions. This is by far not ideal, but I found this to be the best way without compromising #1558 or future hooks.
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.
🌟 What is the purpose of this PR?
This is in preparation for #1558 and generalizes the
HookContext(notably storage) into its own (isolated) typeHookContext<T, U>, which is generic over two parameters:T, which are the extra values that might be needed ndU, the current type accessed and used for storage partitioning.Why is this needed?
serdehooks will also need a way to use and store context-sensitive information. I found a lot of code duplication when trying to mirror the storage API, so I chose the consolidation into a single struct. This is purely an internal change and does not change anything for library consumers.👂 Open Questions
Because cargo-doc considershook::context::HookContextto be private, we currently do not generate any docs for the new inner type. We would need a way to expose those.Using
cfg(doc)we now expose the struct, which is a bit hacky but enables documentation of all functions.🔗 Related links
📜 Does this require a change to the docs?
No, purely internal change.
🛡 What tests cover this?
Existing tests.