Consider adding "Safety" section to docs of unsafe functions
Clippy suggests to add a # Safety
section to unsafe function's docs, to document their safety preconditions (Lint documentation).
warning: unsafe function's docs miss `# Safety` section
--> src/hash/hash.rs:30:5
|
30 | unsafe fn nettle_hash() -> &'static nettle_hash;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: `#[warn(clippy::missing_safety_doc)]` on by default
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_safety_doc
warning: unsafe function's docs miss `# Safety` section
--> src/random/types.rs:9:5
|
9 | unsafe fn context(&mut self) -> *mut c_void;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_safety_doc
warning: unsafe function's docs miss `# Safety` section
--> src/random/types.rs:11:5
|
11 | / unsafe extern "C" fn random_impl(
12 | | ctx: *mut c_void, length: size_t, dst: *mut u8,
13 | | );
| |______^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_safety_doc
warning: unsafe function's docs miss `# Safety` section
--> src/ecc/curves.rs:10:5
|
10 | unsafe fn get_curve() -> *const ecc_curve;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_safety_doc
warning: unsafe function's docs miss `# Safety` section
--> src/ecc/curves.rs:13:5
|
13 | / unsafe fn bit_size() -> u32 {
14 | | nettle_ecc_bit_size(Self::get_curve())
15 | | }
| |_____^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_safety_doc
warning: 5 warnings emitted
Finished dev [unoptimized + debuginfo] target(s) in 0.05s