-
Notifications
You must be signed in to change notification settings - Fork 533
Elaborate on how to use an extern static correctly #736
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -38,6 +38,8 @@ Two kind of item _declarations_ are allowed in external blocks: [functions] and | |
[statics]. Calling functions or accessing statics that are declared in external | ||
blocks is only allowed in an `unsafe` context. | ||
|
||
## Functions | ||
|
||
Functions within external blocks are declared in the same way as other Rust | ||
functions, with the exception that they may not have a body and are instead | ||
terminated by a semicolon. Patterns are not allowed in parameters, only | ||
|
@@ -53,10 +55,19 @@ extern "abi" for<'l1, ..., 'lm> fn(A1, ..., An) -> R`, where `'l1`, ... `'lm` | |
are its lifetime parameters, `A1`, ..., `An` are the declared types of its | ||
parameters and `R` is the declared return type. | ||
|
||
## Statics | ||
|
||
Statics within external blocks are declared in the same way as statics outside of external blocks, | ||
except that they do not have an expression initializing their value. | ||
It is `unsafe` to access a static item declared in an extern block, whether or | ||
not it's mutable. | ||
not it's mutable, because there is nothing guaranteeing that the bit pattern at the static's | ||
memory is valid for the type it is declared with, since some arbitrary (e.g. C) code is in charge | ||
of initializing the static. | ||
|
||
Extern statics can be either immutable or mutable just like statics outside of external blocks. | ||
An immutable static *must* be initialized before any Rust code is executed. It is not enough for | ||
the static to be initialized before Rust code reads from it. This may change in the future, but for | ||
now, if you want to lazily initialize such a static, use a mutable static. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove the last sentence. The reference is not a user guide / should not contain advice. |
||
|
||
## ABI | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link to ordinary statics here.