Document that #[inline] is needed for inlining across crate boundaries - #2326
Open
de-vri-es wants to merge 1 commit into
Open
Document that #[inline] is needed for inlining across crate boundaries#2326de-vri-es wants to merge 1 commit into
#[inline] is needed for inlining across crate boundaries#2326de-vri-es wants to merge 1 commit into
Conversation
rustbot
added
the
S-waiting-on-review
de-vri-es
changed the title
#[inline] is needed for inlining across crate boundar…#[inline] is needed for inlining across crate boundaries
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adding an
#[inline]hint may not be the right wayTM to allow in-lining across crate boundaries, but as far as I'm aware it is the only way. It would be nice to document that, to have something to point at when people ask why I think this attribute should be added.The current docs suggest it should almost never be used, unless you know better than the compiler (which I don't want to claim, normally). But using it to allow the compiler to be smart is a good thing.
Alternatively, if this is no longer necessary, it would be good to explicitly document that (to have something to point at).
If there are plans to change this behavior I suppose this could also be added as a note instead.