Solutions for Advent of Code in Rust.
Day | Part 1 | Part 2 |
---|---|---|
Day 1 | โญ | โญ |
Day 2 | โญ | โญ |
Day 3 | โญ | โญ |
Day 4 | โญ | โญ |
Day 5 | โญ | โญ |
Day 6 | โญ | โญ |
Day 7 | โญ | โญ |
Day 8 | โญ | โญ |
Day 9 | โญ | โญ |
Day 10 | โญ | โญ |
Day 11 | โญ | โญ |
Day 12 | โญ | โญ |
Day 13 | โญ | โญ |
Day 14 | โญ | โญ |
Day 15 | โญ | โญ |
Day 18 | โญ | โญ |
Day 19 | โญ | โญ |
Day 20 | โญ | โญ |
Day 21 | โญ | โญ |
This template supports all major OS (macOS, Linux, Windows).
- Open the template repository on Github.
- Click Use this template and create your repository.
- Clone your repository to your computer.
- Install the Rust toolchain.
- (recommended) Install the rust-analyzer extension for your code editor.
- (optional) Install a native debugger. If you are using VS Code, CodeLLDB is a good option.
โจ You can start solving puzzles now! Head to the Usage section to see how to use this template. If you like, you can configure some optional features.
# example: `cargo scaffold 1`
cargo scaffold <day>
# output:
# Created module "src/bin/01.rs"
# Created empty input file "src/inputs/01.txt"
# Created empty example file "src/examples/01.txt"
# ---
# ๐ Type `cargo solve 01` to run your solution.
Individual solutions live in the ./src/bin/
directory as separate binaries.
Every solution has unit tests referencing its example file. Use these unit tests to develop and debug your solution against the example input. For some puzzles, it might be easier to forgo the example file and hardcode inputs into the tests.
When editing a solution, rust-analyzer
will display buttons for running / debugging unit tests above the unit test blocks.
Note
This command requires installing the aoc-cli crate.
# example: `cargo download 1`
cargo download <day>
# output:
# Loaded session cookie from "/Users/<snip>/.adventofcode.session".
# Fetching puzzle for day 1, 2022...
# Saving puzzle description to "src/puzzles/01.md"...
# Downloading input for day 1, 2022...
# Saving puzzle input to "src/inputs/01.txt"...
# Done!
# ---
# ๐ Successfully wrote input to "src/inputs/01.txt".
# ๐ Successfully wrote puzzle to "src/puzzles/01.md".
To download inputs for previous years, append the --year/-y
flag. (example: cargo download 1 --year 2020
)
Puzzle descriptions are stored in src/puzzles
as markdown files. Puzzle inputs are not checked into git. Reasoning.
# example: `cargo solve 01`
cargo solve <day>
# output:
# Running `target/debug/01`
# ๐ Part 1 ๐
#
# 6 (elapsed: 37.03ยตs)
#
# ๐ Part 2 ๐
#
# 9 (elapsed: 33.18ยตs)
solve
is an alias for cargo run --bin
. To run an optimized version for benchmarking, append the --release
flag.
Displayed timings show the raw execution time of your solution without overhead (e.g. file reads).
cargo all
# output:
# Running `target/release/advent_of_code`
# ----------
# | Day 01 |
# ----------
# ๐ Part 1 ๐
#
# 0 (elapsed: 170.00ยตs)
#
# ๐ Part 2 ๐
#
# 0 (elapsed: 30.00ยตs)
# <...other days...>
# Total: 0.20ms
all
is an alias for cargo run
. To run an optimized version for benchmarking, use the --release
flag.
Total timing is computed from individual solution timings and excludes as much overhead as possible.
cargo test
To run tests for a specific day, append --bin <day>
, e.g. cargo test --bin 01
. You can further scope it down to a specific part, e.g. cargo test --bin 01 part_one
.
cargo fmt
cargo clippy
Note
This command requires installing the aoc-cli crate.
# example: `cargo read 1`
cargo read <day>
# output:
# Loaded session cookie from "/Users/<snip>/.adventofcode.session".
# Fetching puzzle for day 1, 2022...
# ...the input...
To read inputs for previous years, append the --year/-y
flag. (example: cargo read 1 --year 2020
)
- Install
aoc-cli
via cargo:cargo install aoc-cli --version 0.7.0
- Create an
.adventofcode.session
file in your home directory and paste your session cookie1 into it. To get this, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in your Cookies under the Application or Storage tab, and copy out thesession
cookie value.
Once installed, you can use the download command.
Uncomment the format
job in the ci.yml
workflow to enable fmt checks in CI.
Uncomment the clippy
job in the ci.yml
workflow to enable clippy checks in CI.
This template includes a Github action that automatically updates the readme with your advent of code progress.
To enable it, complete the following steps:
Go to the leaderboard page of the year you want to track and click Private Leaderboard. If you have not created a leaderboard yet, create one by clicking Create It. Your leaderboard should be accessible under https://adventofcode.com/{year}/leaderboard/private/view/{aoc_user_id}
.
Go to the Secrets tab in your repository settings and create the following secrets:
AOC_ENABLED
: This variable controls whether the workflow is enabled. Set it totrue
to enable the progress tracker.AOC_USER_ID
: Go to this page and copy your user id. It's the number behind the#
symbol in the first name option. Example:3031
AOC_YEAR
: the year you want to track. Example:2021
AOC_SESSION
: an active session2 for the advent of code website. To get this, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in your Cookies under the Application or Storage tab, and copy out thesession
cookie.
โจ You can now run this action manually via the Run workflow button on the workflow page. If you want the workflow to run automatically, uncomment the schedule
section in the readme-stars.yml
workflow file or add a push
trigger.
- Install rust-analyzer and CodeLLDB.
- Set breakpoints in your code. 3
- Click Debug next to the unit test or the main function. 4
- The debugger will halt your program at the specific line and allow you to inspect the local stack. 5
- itertools: Extends iterators with extra methods and adaptors. Frequently useful for aoc puzzles.
- regex: Official regular expressions implementation for Rust.
A curated list of popular crates can be found on blessred.rs.
Do you have aoc-specific crate recommendations? Share them!
- Integer overflows: This template uses 32-bit integers by default because it is generally faster - for example when packed in large arrays or structs - than using 64-bit integers everywhere. For some problems, solutions for real input might exceed 32-bit integer space. While this is checked and panics in
debug
mode, integers wrap inrelease
mode, leading to wrong output when running your solution.
Footnotes
-
The session cookie might expire after a while (~1 month) which causes the downloads to fail. To fix this issue, refresh the
.adventofcode.session
file. โฉ -
The session cookie might expire after a while (~1 month) which causes the automated workflow to fail. To fix this issue, refresh the AOC_SESSION secret. โฉ
-
โฉ
-
โฉ
-
โฉ