https://github.com/emilgardis/cargo-whynot

https://github.com/emilgardis/cargo-whynot

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/emilgardis/cargo-whynot
• Owner: Emilgardis
• License: other
• Created: 2022-04-20T23:15:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-27T10:32:23.000Z (about 2 years ago)
• Last Synced: 2024-03-15T00:22:52.122Z (10 months ago)
• Language: Rust
• Homepage:
• Size: 108 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# Why Not?

[![github]](https://github.com/emilgardis/cargo-whynot) [![crates-io]](https://crates.io/crates/cargo-whynot)

[github]: https://img.shields.io/badge/github-emilgardis/cargo--whynot-8da0cb?style=for-the-badge&labelColor=555555&logo=github

[crates-io]: https://img.shields.io/crates/v/cargo-whynot.svg?style=for-the-badge&color=fc8d62&logo=rust

Cargo subcommand to discover why a function is unsafe.

Requires a recent enough nightly rust toolchain.

```text

# Make sure you have the necessary components installed

$ rustup component add rustc-dev llvm-tools-preview --toolchain nightly

# Install `cargo-whynot` with the nightly toolchain

$ cargo +nightly install cargo-whynot

# Invoke the tool!

$ cargo whynot safe foo

```

## What is unsafety?

[Nomicon definition](https://doc.rust-lang.org/nomicon/what-unsafe-does.html)

* Dereference raw pointers

* Call unsafe functions (including C functions, compiler intrinsics, and the raw allocator)

* Implement unsafe traits

* Mutate statics

* Access fields of unions

## Why this tool?

Because it's a fun experiment, hooking into rustc to query the drivers.

You should not use this tool because unsafe code is generally bad (it's not),

but you can use it to figure out if there is an opportunity to make a function "safe".

## Examples

With the following code

```rust

pub use unsafe_mod::unsafety;

pub unsafe fn foo() {

    let a = unsafety();

    eprintln!("a: {}", a);

}

pub mod unsafe_mod {

    pub unsafe fn unsafety() -> u32 {

        let mut a = 1;

        let a = std::ptr::addr_of_mut!(a);

        // this is the unsafe part

        let b = *a;

        b

    }

}

```

`cargo whynot safe foo`

will report

```text

note: Function is unsafe

  ┌─ src/lib.rs:3:1

  │

3 │ pub unsafe fn foo() {

  │ ^^^^^^^^^^^^^^^^^^^ function is unsafe because:

4 │     let a = unsafety();

  │             ---------- call to unsafe function `unsafe_mod::unsafety`

help:

   ┌─ src/lib.rs:9:5

   │

 9 │     pub unsafe fn unsafety() -> u32 {

   │     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ function is unsafe because:

   ·

13 │         let b = *a;

   │                 ^^ dereference of raw pointer

   │

   = this function does a fundamentally unsafe operation

```

 License 




Licensed under either of Apache License, Version

2.0 or MIT license at your option.








Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in this crate by you, as defined in the Apache-2.0 license, shall

be dual licensed as above, without any additional terms or conditions.