Rust Binary Template

A template for binary executable Rust projects.

“Features”

AKA personal preferences.

• source/ instead of src/ directory.
• Main function with Result<(), Box<dyn Error>> return type for the ? operator.
• Rustfmt configuration with:
  • 80 character max line length.
  • 2 space indentation.
• Cargo lockfile not gitignored as per The Cargo Book.

Usage

The command below will:

• Clone the project to new-project.
• Change directory into it.
• Remove the existing git history.
• Initialize git to start anew.
• Replace rust-bin-template in Cargo.toml with new-project.

git clone "https://git.holllo.cc/Bauke/rust-bin-template.git" new-project &&
cd $_ &&
rm -rf .git/ &&
git init &&
sed -i "s|rust-bin-template|$1|" "Cargo.toml"

Reusable Function

Add this to your .bashrc, .zshrc (or similar) configuration so you don’t have to copy-paste that whole command every time.

new-rust-bin () {
  git clone "https://git.holllo.cc/Bauke/rust-bin-template.git" "$1" &&
  cd "$1" &&
  rm -rf .git/ &&
  git init &&
  sed -i "s|rust-bin-template|$1|" "Cargo.toml"
}

Then use it as new-rust-bin new-project.

License

Open-sourced with the Unlicense.