https://github.com/ewpratten/foot-gun

Friendly aliases for your unsafe code [Joke Library]
https://github.com/ewpratten/foot-gun

flukejones joke-library rust rust-library twitter

Last synced: 7 days ago
JSON representation

Friendly aliases for your unsafe code [Joke Library]

• Host: GitHub
• URL: https://github.com/ewpratten/foot-gun
• Owner: ewpratten
• License: gpl-3.0
• Created: 2021-07-20T14:28:16.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-07-20T14:41:20.000Z (over 3 years ago)
• Last Synced: 2024-10-09T16:42:42.062Z (28 days ago)
• Topics: flukejones, joke-library, rust, rust-library, twitter
• Language: Rust
• Homepage: https://crates.io/crates/foot-gun
• Size: 14.6 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# foot-gun

[![Crates.io](https://img.shields.io/crates/v/foot-gun)](https://crates.io/crates/foot-gun) 

[![Docs.rs](https://docs.rs/foot-gun/badge.svg)](https://docs.rs/foot-gun) 

[![Build](https://github.com/Ewpratten/foot-gun/actions/workflows/build.yml/badge.svg)](https://github.com/Ewpratten/foot-gun/actions/workflows/build.yml)

[![Clippy](https://github.com/Ewpratten/foot-gun/actions/workflows/clippy.yml/badge.svg)](https://github.com/Ewpratten/foot-gun/actions/workflows/clippy.yml)

[![Audit](https://github.com/Ewpratten/foot-gun/actions/workflows/audit.yml/badge.svg)](https://github.com/Ewpratten/foot-gun/actions/workflows/audit.yml)

The `foot-gun` crate is a joke library inspired by [this twitter thread](https://twitter.com/flukejones/status/1417241932154081294).

This crate provides the following macros:

 - `foot_gun`

 - `here_be_dragons`

 - `beware`

 - `behold`

 - `en_garde`

 - `i_got_this`

 - `hold_my_borrowchk`

All macros are credited to their "inventors" in RustDoc.

## Examples

```rust

foot_gun!({

    // Unsafe code here

});

here_be_dragons!({

    // Unsafe code here

});

beware!({

    // Unsafe code here

});

behold!({

    // Unsafe code here

});

en_garde!({

    // Unsafe code here

});

i_got_this!({

    // Unsafe code here

});

hold_my_borrowchk!({

    // Unsafe code here

});

```