Repository files navigation

Solutions forAdvent of Code inRust.

This template supports all major OS (macOS, Linux, Windows).

1. Openthe template repository on Github.
2. ClickUse this template and create your repository.
3. Clone your repository to your computer.
4. If you are solving a previous year's advent of code, change theAOC_YEAR variable in.cargo/config.toml to reflect the year you are solving.

1. Install theRust toolchain.
2. (recommended) Install therust-analyzer extension for your code editor.
3. (optional) Install a native debugger. If you are using VS Code,CodeLLDB is a good option.

✨ You can start solving puzzles now! Head to theUsage section to see how to use this template. If you like, you can configuresome optional features.

# example: `cargo scaffold 1`cargo scaffold<day># output:# Created module file "src/bin/01.rs"# Created empty input file "data/inputs/01.txt"# Created empty example file "data/examples/01.txt"# ---# 🎄 Type `cargo solve 01` to run your solution.

Individual solutions live in the./src/bin/ directory as separate binaries.Inputs andexamples live in the the./data directory.

Everysolution hastests referencing itsexample file in./data/examples. Use these tests to develop and debug your solutions against the example input.

# example: `cargo download 1`cargo download<day># output:# [INFO  aoc] 🎄 aoc-cli - Advent of Code command-line tool# [INFO  aoc_client] 🎅 Saved puzzle to 'data/puzzles/01.md'# [INFO  aoc_client] 🎅 Saved input to 'data/inputs/01.txt'# ---# 🎄 Successfully wrote input to "data/inputs/01.txt".# 🎄 Successfully wrote puzzle to "data/puzzles/01.md".

# example: `cargo solve 01`cargo solve<day># output:#     Finished dev [unoptimized + debuginfo] target(s) in 0.13s#     Running `target/debug/01`# Part 1: 42 (166.0ns)# Part 2: 42 (41.0ns)

Thesolve command runs your solution against real puzzle inputs. To run an optimized build of your code, append the--release flag as with any other rust program.

By default,solve executes your code once and shows the execution time. If you append the--time flag to the command, the runner will run your code between10 and10.000 times (depending on execution time of first execution) and print the average execution time.

For example, running a benchmarked, optimized execution of day 1 would look likecargo solve 1 --release --time. Displayedtimings show the raw execution time of your solution without overhead like file reads.

In order to submit part of a solution for checking, append the--submit <part> option to thesolve command.

cargo all# output:#     Running `target/release/advent_of_code`# ----------# | Day 01 |# ----------# Part 1: 42 (19.0ns)# Part 2: 42 (19.0ns)# <...other days...># Total: 0.20ms

This runs all solutions sequentially and prints output to the command-line. Same as for thesolve command, the--release flag runs an optimized build.

The template can output a table with solution times to your readme. In order to generate a benchmarking table, runcargo all --release --time. If everything goes well, the command will output "Successfully updated README with benchmarks." after the execution finishes and the readme will be updated.

Please note that these are not "scientific" benchmarks, understand them as a fun approximation. 😉 Timings, especially in the microseconds range, might change a bit between invocations.

cargotest

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

# example: `cargo read 1`cargoread<day># output:# Loaded session cookie from "/Users/<snip>/.adventofcode.session".# Fetching puzzle for day 1, 2022...# ...the input...

1. Installaoc-cli via cargo:cargo install aoc-cli --version 0.12.0
2. Create an.adventofcode.session file in your home directory and paste your session cookie. To retrieve the session cookie, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look inCookies under theApplication orStorage tab, and copy out thesession cookie value.¹

Once installed, you can use thedownload command, the read command, and automatically submit solutions via the--submit flag.

This template includesa 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 clickPrivate Leaderboard. If you have not created a leaderboard yet, create one by clickingCreate It. Your leaderboard should be accessible underhttps://adventofcode.com/{year}/leaderboard/private/view/{aoc_user_id}.

Go to theSecrets tab in your repository settings and create the following secrets:

• AOC_USER_ID: Go tothis 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 session² 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.

Go to theVariables tab in your repository settings and create the following variable:

• AOC_ENABLED: This variable controls whether the workflow is enabled. Set it totrue to enable the progress tracker. After you complete AoC or no longer work on it, you can set this tofalse to disable the CI.

✨ You can now run this action manually via theRun workflow button on the workflow page. If you want the workflow to run automatically, uncomment theschedule section in thereadme-stars.yml workflow file or add apush trigger.

Uncomment the respective sections in theci.yml workflow.

1. Installrust-analyzer andCodeLLDB.
2. Set breakpoints in your code.³
3. ClickDebug next to the unit test or themain function.⁴
4. The debugger will halt your program at the specific line and allow you to inspect the local stack.⁵

• 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 onblessred.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 indebug mode, integerswrap inrelease mode, leading to wrong output when running your solution.