Skip to content
Basic

Reading levels

Every page has a small badge above its title. It says how much the page assumes. Read the Basic pages first and stop when you have what you need.

  • Basic

    What you need to use the crate: what a feature is for, the common case, a working example. Start here.

  • Advanced

    Every option and when to pick it: rounding, overflow, fixed-point products, complex numbers. For when the defaults are not enough.

  • Nomicon

    The inside, as in the Rustonomicon: exact magnitudes, how a conversion is worked out at compile time, how the crate is tested and proved.

A level says how much a page assumes, not how important it is.

In the navigation, each part lists its Basic pages first and groups the Advanced ones after them.

For writers

  • The badge comes from the page's front matter: level: basic, level: advanced or level: nomicon. overrides/partials/level.html draws it.
  • Every Rust block on a page is a doctest (src/book.rs includes the page). A block that must not compile is fenced rust,compile_fail; the site labels it.
  • Formulas are LaTeX between $...$ (inline) or $$...$$ (display), drawn by KaTeX.
  • A number's bit layout is a bits fence: one field per line with its kind (sign, int, frac, quad, pad), its bits and a label, then a hex line with the stored integer. The build fails when the bits don't make it.
  • Drawings are SVG files in docs/figures, inlined with --8<-- so they follow the light and dark scheme. Plots are computed by the crate itself (tools/book_plots) when the site is built; they are not in git.