// Check for updates
rustup check
// Update Rust
rustup update
// Hello World
cargo new testrust && cd $_
// Run your code
cargo run
// Check prj & depenedices for basic structural errors
cargo check
// Compile but do NOT run*
cargo build
// Rm entire $TargerDirectory
cargo clean
// *Cargo run/build ::> built into DEBUG mode == slow!
cargo run
// Compile/run prgm in RELEASE mode (NO debugger support) == fast!
cargo run --release
// Format the *entire* prj to Rust's std layout (run throughout prj)
cargo fmt
// Find issues w/ the *content* of your code (see Glossary: cargo > clippy)
cargo clippy
// Search for available crates
cargo search [search_term] // bracket-terminal | slotmap
💡 Use snake_case: snake_case
// In project's root directory
cargo new [prj name]
// -OR- without git integration
cargo new --vcs=none [prj name]
// Run your program
cargo run
Crates (pkgs) are available for free on the crates.io system.
// 1. Search for crates
cargo search [search_term]
/* 2. Add it to `Cargo.toml` > `[dependencies]` section:
* 2.1 Simple dependency installation (see: version numbers in Glossary) */
[dependencies]
crate_name = "0.8.0"
// 2.2 Use GitHub version of crate
crate-name = { git = "https://github.com/user/crate-name"}
// 2.3 Configure crate-name's FEATURE FLAGS to use `Amethyst` as its back-end
crate-name = {
git = "http://github.com/user/crate-name",
default-features = false,
features = [ "amethyst_engine_vulkan" ]
}
/* 3. Remove/delete dependency
* 3.1 Delete crate from `Cargo.toml` > `[depenedices]` section
* 3.2 Then run the following cargo cmd to delete them from your computer */
cargo clean
## Open source file
vim Cargo.toml
// Increase clippy pedantic-ness
#![warn(clippy::all, clippy::pedantic)]
// functions main
fn main() {}
// functions
fn name() {}
// exclamation mark: marks a MACRO
println!("Hello, world!")
Amethyst: a game engine framework written in Rust.
- Provides higher-level abstractions for game development, including graphics rendering using APIs (ie. OpenGL, Vulkan).
- (vs.) OpenGL: a graphics API that allows developers to interact with graphics HW to render graphics.
clippy: a bossy little mascot who criticizes all of your code. Ultimately a learning tool and can help you avoid mistakes.
cargo: Rust's package manager; also manages collections of crates.
Cargo.toml
: Project meta-data, describing your project.Cargo.toml
>[package]
: (Metadata) section of theCargo.toml
file describes your crate.Cargo.toml
>authors =
: (Metadata) a list of author names in quotation marks denoted by sqare brackets.Cargo.toml
>edition =
: (Metadata) the major edition of Rust.Cargo.toml
>name =
: (Metadata) the name of your program.Cargo.toml
>version =
: (Metadata) the version of your project.cargo clippy
: provides hints & guidance while coding.- Crate Version Numbers: "[major].[minor].[patch]" (pg. 15)
crates: Rust's name for packeages; available for free on the crates.io system.
Feature flags: are optional functionality provided by a crate.
./src
: a dir containing source code.
./src/main.rs
: a minimal source code file containing the code required.
TOML (Tom's Obvious, Minimal Language): a format used to describe your program Cargo.toml
and divides information about your crate into sections.