Chapter 1: Getting Started

Welcome to the demo of mdbook-inplace-notes!

Simple inline notes

The HashMap type¹A hash map implemented with quadratic probing and SIMD lookup. See std::collections for details. is Rust’s standard key-value store.

Here’s a Vec²A contiguous, growable array type, written Vec<T>. It allocates on the heap and provides O(1) indexing. — the most common collection.

Notes with inline formatting

The ? operator³The ? operator is syntactic sugar for propagating errors. It’s equivalent to match with early return on Err. simplifies error handling in Rust.

Use cargo build --release⁴The –release flag enables optimizations (equivalent to opt-level = 3 in Cargo.toml). Builds are slower but runtime is much faster. for production builds.

Notes with block content

Ownership in Rust

is what makes Rust unique.

Multiple notes in one paragraph

Rust has several string⁶String is an owned, heap-allocated, growable UTF-8 string. types⁷&str is a borrowed string slice pointing to valid UTF-8 data. for different use cases.

Chapter 2: Advanced Notes

This chapter covers more complex note content.

Notes with code blocks

The Iterator trait

#![allow(unused)]
fn main() {
pub trait Iterator {
    type Item;
    fn next(&mut self) -> Option<Self::Item>;
}
}

powers Rust’s functional programming patterns.

Notes with lists

Error handling in Rust

is versatile and explicit.

Notes with blockquotes

The module system

helps organize large codebases.

Notes with inline code and links

Clippy⁴Run cargo clippy to get lint suggestions. Configure with #[allow(clippy::some_lint)] attributes. See the Clippy Lints page. catches common mistakes.

Notes with tables

Rust edition differences

can trip up newcomers.