R·U·S·T·M·A·X

News

RSS

Rustmax 0.0.10 Released

Rustmax 0.0.10 is released.

Eleven of the re-exported crates moved to a new major version.

Crate upgrades

  • base64 0.22 → 0.23
  • comrak 0.35 → 0.54
  • itertools 0.14 → 0.15
  • num-bigint 0.4 → 0.5
  • rand, rand_chacha, rand_pcg 0.9 → 0.10
  • rustyline 17 → 18
  • sha2 0.10 → 0.11
  • syn 2 → 3
  • tera 1 → 2
  • toml 0.9 → 1.1
  • zip 7 → 8

API rendering

The custom rustdoc renderer that produces the API documentation got a pass for correctness and speed.

Read more

Rustmax 0.0.9 Released

Rustmax 0.0.9 is released with 20 commits since 0.0.8.

Continuing to fill in the crate documentation backlog.

New crate documentation

Added doc pages with examples for 10 crates:

  • cfg-if - Conditional compilation macros
  • extension-trait - Inline extension trait definitions
  • json5 - JSON5 parser
  • libc - Raw FFI bindings to platform APIs
  • quote - Quasi-quoting for proc macros
  • rand_chacha - ChaCha random number generator
  • rand_pcg - PCG random number generator
  • rustyline - Readline-style line editing
  • socket2 - Low-level socket configuration

Read more

Documentation and API doc fixes

A big round of crate documentation and API doc generator improvements. It's becoming more viable to use as a real doc tool.

New crate documentation and examples - Added doc pages for axum, tower, hyper, http, ctrlc, termcolor, and tera.

API doc generator fixes - Getting the custom rustdoc renderer to behave as expected and/or similar to rustdoc is a slog. And our implementation has grown organically: fix one link, break another. Complicated by my insistence on rendering fewer duplicate pages that rustdoc, so deciding where the "real" docs live and routing links correctly is tough.

Search improvements

Lots of search improvements since the initial launch last week.

Keyboard navigation - Arrow keys now move through search results and enter navigates to the selected result.

CLI search - rustmax search <query> runs the same search algorithm from the command line, outputting results as TOML. Running the CLI outside the repo mostly doesn't actually work though.

Better matching - The search algorithm and metadata is improved in many ways, and should be minimally useful now.

Read more

New search feature

I've added the barest of search functionality.

The idea with Rustmax search is that is will be curated with topics related to Rustmax: crates, books and their chapters, standard library modules. Definitely not a full-text search like rustdoc; need to keep the index small.

Right now it only searches crates, books and standard library modules, by name or aliases.

I'll expand this basic search to be a bit more rich and robust with curated keywords etc; then augment it with things like function names, types, etc.

Rustmax 0.0.8 Released

Rustmax 0.0.8 is released with 73 commits since 0.0.7.

No new crates. Mostly releasing this to test hint-mostly-unused.

Since the previous release I've switched the API rendering to a custom rustdoc renderer. Now the website shares a consistent style between books, rustdocs, and website pages.

Graveyard additions

  • memoffset - Superseded by std::mem::offset_of!

Rustmax 0.0.7 Released

Rustmax 0.0.7 is released with 72 commits since 0.0.6.

New crates

Working on the backlog. These are all crates that I either use regularly or are the obvious crate for a common feature.

Read more

Rustmax 0.0.6 Released

Rustmax 0.0.6 is released with 289 commits since 0.0.5.

Highlights

WASM profile - New rmx-profile-wasm feature enables a curated subset of crates compatible with WebAssembly targets. This is a nice baseline to use for projects that need wide platform compatibility, but more than just no-std.

Powerletters in prelude - The powerletters are now in their own crate and reexported. See the blog post, Powerletters for Rust.

Read more