diff --git a/pages/common/rustfmt.md b/pages/common/rustfmt.md new file mode 100644 index 0000000000..0226eadf71 --- /dev/null +++ b/pages/common/rustfmt.md @@ -0,0 +1,15 @@ +# rustfmt + +> Tool for formatting Rust source code. + +- Format a file, overwriting the original file in-place: + +`rustfmt {{source.rs}}` + +- Check a file for formatting and display any changes on the console: + +`rustfmt --check {{source.rs}}` + +- Backup any modified files before formatting (the original file is renamed with a `.bk` extension): + +`rustfmt --backup {{source.rs}}`