Skip to content

Commit 5bbf379

Browse files
traviscrossehuss
authored andcommitted
Add to unsafety section for unsafe attributes
Let's describe unsafe attributes in the chapter on unsafety.
1 parent e588d82 commit 5bbf379

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

src/unsafe-keyword.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# The `unsafe` keyword
22

33
The `unsafe` keyword can occur in several different contexts:
4-
unsafe functions (`unsafe fn`), unsafe blocks (`unsafe {}`), unsafe traits (`unsafe trait`), unsafe trait implementations (`unsafe impl`), and unsafe external blocks (`unsafe extern`).
4+
unsafe functions (`unsafe fn`), unsafe blocks (`unsafe {}`), unsafe traits (`unsafe trait`), unsafe trait implementations (`unsafe impl`), unsafe external blocks (`unsafe extern`), and unsafe attributes (`#[unsafe(attr)]`).
55
It plays several different roles, depending on where it is used and whether the `unsafe_op_in_unsafe_fn` lint is enabled:
66
- it is used to mark code that *defines* extra safety conditions (`unsafe fn`, `unsafe trait`)
7-
- it is used to mark code that needs to *satisfy* extra safety conditions (`unsafe {}`, `unsafe impl`, `unsafe fn` without [`unsafe_op_in_unsafe_fn`], `unsafe extern`)
7+
- it is used to mark code that needs to *satisfy* extra safety conditions (`unsafe {}`, `unsafe impl`, `unsafe fn` without [`unsafe_op_in_unsafe_fn`], `unsafe extern`, `#[unsafe(attr)]`)
88

99
The following discusses each of these cases.
1010
See the [keyword documentation][keyword] for some illustrative examples.
@@ -62,3 +62,9 @@ Unsafe trait implementations are the logical dual to unsafe traits: where unsafe
6262
The programmer who declares an [external block] must assure that the signatures of the items contained within are correct. Failing to do so may lead to undefined behavior. That this obligation has been met is indicated by writing `unsafe extern`.
6363

6464
[external block]: items/external-blocks.md
65+
66+
## Unsafe attributes (`#[unsafe(attr)]`)
67+
68+
An [unsafe attribute] is one that has extra safety conditions that must be upheld when using the attribute. The compiler cannot check whether these conditions have been upheld. To assert that they have been, these attributes must be wrapped in `unsafe(..)`, e.g. `#[unsafe(no_mangle)]`.
69+
70+
[unsafe attribute]: attributes.md

src/unsafety.md

+2
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@ Rust:
1212
- Calling an unsafe function (including an intrinsic or foreign function).
1313
- Implementing an [unsafe trait].
1414
- Declaring an [`extern`] block.
15+
- Applying an [unsafe attribute] to an item.
1516

1617
[`extern`]: items/external-blocks.md
1718
[`union`]: items/unions.md
1819
[mutable]: items/static-items.md#mutable-statics
1920
[external]: items/external-blocks.md
2021
[raw pointer]: types/pointer.md
2122
[unsafe trait]: items/traits.md#unsafe-traits
23+
[unsafe attribute]: attributes.md

0 commit comments

Comments
 (0)