Clippy lints / Correctness
Clippy lint · Correctness · checked with Clippy 0.1.99
clippy::transmute_null_to_fn: transmuting a known null pointer into a function pointer
What it meansChecks for null function pointer creation through transmute. It is in the correctness group and denied by default (the build fails).
What you see
error: transmuting a known null pointer into a function pointer --> main.rs:3:30 | 3 | let null_fn: fn() = unsafe { std::mem::transmute( std::ptr::null::<()>() ) }; | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ this transmute results in undefined behavior | = help: try wrapping your function pointer type in `Option<T>` instead, and using `None` as a null pointer value = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#transmute_null_to_fn = note: `#[deny(clippy::transmute_null_to_fn)]` on by default
Real output of Clippy 0.1.99 (Rust 1.99) on the example below. Names and line numbers in yours will differ.
Does it matter?
Creating a null function pointer is undefined behavior. More info: https://doc.rust-lang.org/nomicon/ffi.html#the-nullable-pointer-optimization
Code that is almost certainly wrong. Denied by default: the build fails until you fix it or allow it.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
let null_fn: fn() = unsafe { std::mem::transmute( std::ptr::null::<()>() ) };
Write this instead
let null_fn: Option<fn()> = None;
Turn it off, or on
Allow it where it does not fit your code, as narrowly as you can:
On one item
#[allow(clippy::transmute_null_to_fn)]
fn my_function() { /* ... */ }Whole crate (Cargo.toml)
[lints.clippy]
transmute_null_to_fn = "allow"One run
cargo clippy -- -A clippy::transmute-null-to-fnThe [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.
Clippy's own documentation
What it does
Checks for null function pointer creation through transmute.
Why is this bad?
Creating a null function pointer is undefined behavior.
More info: https://doc.rust-lang.org/nomicon/ffi.html#the-nullable-pointer-optimization
Known problems
Not all cases can be detected at the moment of this writing.
For example, variables which hold a null pointer and are then fed to a transmute
call, aren’t detectable yet.
Example
let null_fn: fn() = unsafe { std::mem::transmute( std::ptr::null::<()>() ) };
Use instead:
let null_fn: Option<fn()> = None;
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- serde_api_misuseChecks for misuses of the serde API
- size_of_in_element_countDetects expressions where size_of::<T> or size_of_val::<T> is used as a count of elements of type T
- suspicious_splitnChecks for calls to [splitn] (https://doc.rust-lang.org/std/primitive.str.html#method.splitn) and related functions with either zero or one splits
- transmuting_nulltransmuting a known null pointer into a reference
- uninit_assumed_initthis call for this type may be undefined behavior
- uninit_vecChecks for set_len() call that creates Vec with uninitialized elements. This is commonly caused by calling set_len() right after allocating or reserving a buffer with new(), default(), with_capacity(), or reserve()
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::serde_api_misuseChecks for misuses of the serde APIRead it next →Did this answer your question?