Skip to content

Contributing Tips

Bee edited this page Sep 11, 2020 · 4 revisions

Outputting information

We use the module tui.rs as our terminal user interface. Here's some things you ought to know:

  • detail! is for details, such as "starting Nmap" or "File limit higher than batch size".
  • output! is for outputting information, such as the Nmap command to be run.
  • warning! is for explicit warnings. Ideally, you'd want to Panic! But if it isn't such a big deal and the program can still run, use a warning! instead.

All of these macros work seamlessly with quiet mode too. Simply pass in quiet mode as the second argument like so:

detail!("this is a detail", opts.quiet)

Clone this wiki locally