Crate rustmax

Expand description

A collection of Rust crates.

🚧 WARNING: Do not use this project. It is neither stable nor supported. 🚧

This crate documents and reexports selected high-quality Rust crates suitable for many Rust programs. Through the organization of its Cargo features into profiles and ecosystem features, with consistent descriptions of individual crates, it is a guide to the Rust crate ecosystem. It can be read as reference documentation or imported through a Cargo dependency as a “batteries included” supercrate.

Category	Crates
error handling and debugging	`anyhow`, `backtrace`, `env_logger`, `log`, `thiserror`
collections	`ahash`, `bitflags`, `bytes`, `itertools`
numerics	`num_bigint`
encoding, serialization, parsing	`base64`, `flate2`, `hex`, `json5`, `nom`, `regex`, `serde`, `serde_json`, `toml`
time	`chrono`, `jiff`
random numbers	`rand`, `rand_chacha`, `rand_pcg`
cryptography	`blake3`, `sha2`
parallelism	`crossbeam`, `rayon`
asynchronous I/O	`futures`, `tokio`
networking and web	`axum`, `http`, `hyper`, `mime`, `reqwest`, `socket2`, `tera`, `tower`, `url`
text / unicode	`unicode_segmentation`
convenience macros	`cfg-if`, `derive_more`, `extension-trait`, `num_enum`, `powerletters`
terminal / CLI	`clap`, `ctrlc`, `termcolor`, `rustyline`
system / OS	`glob`, `num_cpus`, `tempfile`, `walkdir`, `xshell`
testing	`proptest`, `static_assertions`
FFI / interop	`libc`, `bindgen`, `cc`, `cxx`, `cxx-build`
build scripts	…
deployment and software lifecycle	`semver`
procedural macros	`proc-macro2`, `quote`, `syn`

Profiles. rustmax organizes crates into profiles, which correspond to common target environments and application types.
Ecosystem features. rustmax identifies Cargo features common across many crates.
Rust standard libraries. rustmax re-exports the standard Rust libraries for convenience.
Using rustmax as a library
rustmax crate API docs
- Re-exports
- Modules

§Profiles

rustmax organizes crates into profiles, which correspond to common target environments and application types.

By default no profile is enabled and no crates are exported.

§🌎 Profile: `rmx-profile-no-std`

This profile includes crates that do not require Rust std. It allows use of the Rust allocator, and enables allocator-related features of its crates. All crates in this profile are also in rmx-profile-std.

💡 This profile also enables rmx-feature-no-std.
💡 This profile also enables rmx-rustlibs-no-std.

§Crates in `rmx-profile-no-std`

ahash - A fast and DOS-resistent hash function, for use in HashMaps.
anyhow - Flexible error handling.
backtrace - Callstack backtraces on demand.
base64 - Base-64 encoding and decoding.
bitflags - Types in which the bits are individually addressable.
blake3 - The BLAKE3 cryptographic hash function.
bytes - Abstractions for working with byte buffers: Bytes, Buf, and BufMut.
cfg-if - A macro for writing conditional compilation as if / else blocks.
chrono - Dates and time (legacy).
crossbeam - Concurrency tools to supplement std::sync, including fast channels.
derive_more - derive for more standard traits.
extension-trait - A macro for defining extension methods to external types.
futures - Abstractions for asynchronous programming.
hex - Encoding and decoding hexadecimal strings.
itertools - Additional methods for iterators.
jiff - Dates and time.
libc - Bindings to the C standard library.
log - A simple logging framework.
nom - An efficient parser combinator.
num_bigint - Arbitrary-sized integers.
num_enum - Conversions between numbers and enums.
rand - Random number generators.
rand_chacha - The ChaCha cryptographically-secure random number generators.
rand_pcg - The PCG non-cryptographically-secure random number generators.
semver - The software versioning standard used by Rust.
serde - The standard Rust serialization framework.
serde_json - JSON serialization / deserialization with serde.
sha2 - The SHA2 cryptographic hash functions.
static_assertions - Compile-time assertions about constants, types, etc.
toml - TOML serialization / deserialization with serde.

§🌎 Profile: `rmx-profile-std`

This profile depends on the Rust standard library, and includes crates that require the Rust standard library, in addition to the crates provided by rmx-profile-no-std.

💡 This profile also enables rmx-feature-std.
💡 This profile also enables rmx-feature-default.
💡 This profile also enables rmx-feature-more.
💡 This profile also enables rmx-feature-derive.
💡 This profile also enables rmx-feature-serde.
💡 This profile also enables rmx-rustlibs-std.

§Crates in `rmx-profile-std`

clap - Command line parsing.
env_logger - A basic logger to use with the log crate.
flate2 - Deflate, gzip, and zlib compression and decompression.
glob - Unix shell style pattern matching for paths.
json5 - JSON5, a superset of JSON with expanded syntax.
num_cpus - Get the number of CPUS on a machine.
proptest - Testing over generated inputs, ala QuickCheck.
rayon - Parallel iterators and other parallel processing tools.
regex - Regular expressions.
tempfile - Temporary files and directories.
tera - A text template engine based on Jinja2.
thiserror - Tools for defining custom error types.
unicode-segmentation - Splitting strings on grapheme cluster, word, and sentence boundaries.
walkdir - Efficient directory traversal.
xshell - A Swiss-army knife for writing shell-style scripts in Rust.

§🌎 Profile: `rmx-profile-wasm`

This profile is designed for WebAssembly (WASM) targets. It includes all crates from rmx-profile-no-std, plus additional crates that are compatible with WASM environments.

This profile uses WASM-specific variants of ecosystem features that exclude features incompatible with WASM environments, such as OS-specific threading APIs and file system operations that require native OS support.

💡 This profile also enables rmx-rustlibs-std.
💡 This profile also enables rmx-feature-std-wasm.
💡 This profile also enables rmx-feature-default-wasm.
💡 This profile also enables rmx-feature-more-wasm.
💡 This profile also enables rmx-feature-derive.
💡 This profile also enables rmx-feature-serde.

§Crates in `rmx-profile-wasm`

All crates from rmx-profile-no-std, plus:

clap - Command line parsing.
env_logger - A basic logger to use with the log crate.
flate2 - Deflate, gzip, and zlib compression and decompression.
glob - Unix shell style pattern matching for paths.
json5 - JSON5, a superset of JSON with expanded syntax.
num_cpus - Get the number of CPUS on a machine.
rayon - Parallel iterators and other parallel processing tools.
regex - Regular expressions.
tempfile - Temporary files and directories.
thiserror - Tools for defining custom error types.
unicode-segmentation - Splitting strings on grapheme cluster, word, and sentence boundaries.

Note: Some crates from rmx-profile-std are not included because they require native OS features unavailable in WASM environments: proptest, tera, walkdir, xshell.

§🌎 Profile: `rmx-profile-net`

Adds networking crates, including the tokio async runtime.

Not that this profile does not enable tokio features for other crates; to enable tokio features apply the rmx-feature-tokio feature.

💡 This profile also enables rmx-profile-std.

§Crates in `rmx-profile-net`

axum - Web application framework based on tokio.
http - Shared definitions related to the HTTP protocol.
hyper - HTTP, versions 1 and 2.
mime - MIME media types.
reqwest - Simple HTTP requests, synchronous and asynchronous.
socket2 - Low-level network socket programming beyond std::net.
tokio - An async task runtime and I/O library.
tower - Service request/response abstraction (HTTP middleware) for tokio and axum.
url - URL parsing and data structures.

§🌎 Profile: `rmx-profile-cli`

Crates for building commandline interfaces.

💡 This profile also enables rmx-profile-std.

§Crates in `rmx-profile-cli`

ctrlc - Simple handling of Ctrl-C for CLI programs.
termcolor - Cross-platform library for writing colored output to the terminal.
rustyline - Command-line input reading with history.

§🌎 Profile: `rmx-profile-build-script`

Crates for writing Rust build scripts.

💡 This profile also enables rmx-profile-std.

§Crates in `rmx-profile-build-script`

bindgen - Generate Rust bindings to C and C++ libraries.
cc - A basic cross-platform C/C++ compiler driver.
cxx - C++ bridge runtime support; paired with cxx_build.
cxx-build - C++ bridge generator; paired with cxx.

§🌎 Profile: `rmx-profile-proc-macro`

Crates for writing Rust procedural macros.

💡 This profile also enables rmx-profile-std.
💡 This profile also enables rmx-rustlibs-proc-macro.

§Crates in `rmx-profile-proc-macro`

proc-macro2 - A preferred wrapper around the standard proc_macro crate.
quote - The quote! macro for turning code blocks into source tokens.
syn - A Rust parser used by procedural macros.

§🌎 Profile: `rmx-profile-full`

This profile simply enables all previous profiles.

💡 This profile also enables rmx-profile-std.
💡 This profile also enables rmx-profile-net.
💡 This profile also enables rmx-profile-cli.
💡 This profile also enables rmx-profile-build-script.
💡 This profile also enables rmx-profile-proc-macro.

§🌎 Profile: `rmx-profile-max`

rustmax with all features (that don’t require nightly).

💡 This profile also enables rmx-profile-full.
💡 This profile also enables rmx-feature-derive.
💡 This profile also enables rmx-feature-serde.
💡 This profile also enables rmx-feature-backtrace.
💡 This profile also enables rmx-feature-tokio.

§🌎 Profile: `rmx-profile-max-nightly`

rustmax with all features (including nightly).

💡 This profile also enables rmx-profile-max.
💡 This profile also enables rmx-feature-nightly.

§Ecosystem features

rustmax identifies Cargo features common across many crates.

§⛲ Feature: `rmx-feature-no-std`

This feature is enabled by rmx-profile-no-std. It does not typically need to be set manually.

It enables few features, particularly enabling allocator support for no-std crates that can be compiled without.

§⛲ Feature: `rmx-feature-std`

This feature is enabled by rmx-profile-std. It does not typically need to be set manually.

It enables the “std” feature of crates and other default features that require the standard library.

§⛲ Feature: `rmx-feature-std-wasm`

This feature is enabled by rmx-profile-wasm. It does not typically need to be set manually.

Similar to rmx-feature-std, but excludes features that are incompatible with WebAssembly targets, such as those requiring threading or OS-specific APIs.

§⛲ Feature: `rmx-feature-default`

This feature is enabled by rmx-profile-std. It does not typically need to be set manually.

It enables the “default” feature of crates.

§⛲ Feature: `rmx-feature-default-wasm`

This feature is enabled by rmx-profile-wasm. It does not typically need to be set manually.

Similar to rmx-feature-default, but uses WASM-compatible default features where necessary.

§⛲ Feature: `rmx-feature-more`

This feature is enabled by rmx-profile-std. It does not typically need to be set manually.

This activates extra crate features for convenience that the crates themselves do not typically activate by default.

§⛲ Feature: `rmx-feature-more-wasm`

This feature is enabled by rmx-profile-wasm. It does not typically need to be set manually.

Similar to rmx-feature-more, but excludes features that are incompatible with WebAssembly targets, such as blocking I/O and threading.

§⛲ Feature: `rmx-feature-derive`

Enables derive macros of crates where it is optional, typically with a feature named “derive”.

§⛲ Feature: `rmx-feature-serde`

Enables serde support for crates where it is optional, typically with a feature named “serde”.

§⛲ Feature: `rmx-feature-backtrace`

Enables backtrace support for crates where it is optional, typically with a feature named “backtrace”.

This feature is necessary for backtrace support in anyhow.

This feature also enables rmx-feature-std.

§⛲ Feature: `rmx-feature-tokio`

Enables tokio support for crates where it is optional, typically with a feature named “tokio”.

§⛲Feature: `rmx-feature-nightly`

Enables features that only compile with the Rust [nightly compiler], typically with a feature named “nightly”.

§Rust standard libraries

rustmax re-exports the standard Rust libraries for convenience.

§📙 Rustlib: `rmx-rustlibs-no-std`

§📙 Rustlib: `rmx-rustlibs-alloc`

§📙 Rustlib: `rmx-rustlibs-std`

§📙 Rustlib: `rmx-rustlibs-proc-macro`

§Using `rustmax` as a library.

In your manifest Cargo.toml:

[dependencies]
rmx.package = "rustmax"
rmx.version = "0.0.5"
rmx.features = [
  "rmx-profile-max",
]

Or if using a workspace, in your workspace Cargo.toml

[dependencies]
rmx.version = "0.0.5"
rmx.features = [
  "rmx-profile-max",
]

And in your crate’s Cargo.toml

[dependencies]
rmx.workspace = true

§`rustmax` and cargo features

todo

The main way of configuring the rustmax crates is by enabling the appropriate profile cargo features.

rustmax enables no features by default, and reexports no crates; but for most uses people will want to enable rmx-profile-std. This feature augments the Rust std library with crates that are widely used with a variety of Rust programs, as well as minor helpers missing from the standard library.

[dependencies]
rmx.package = "rustmax"
rmx.version = "0.0.5"
rmx.features = [
  "rmx-profile-max",
]

§Crate reexports

The crates of rustmax are all reexported as modules from the rustmax crate.

use rmx::rand::Rng;

These modules should generally behave the same as the corresponding crates, with exceptions noted in “Known Bugs”. These modules have have rustmax-specific module-level documentation, with a short description and motivation, an example, and relevant links, including to the original crate-level documentation.

These modules are only defined when their crate is configured through cargo features like rmx-profile-std.

§The `rustmax` prelude

§The `extras` module

§Known bugs

serde derive only works if the serde crate is an explicit dependency.
derive_more derives only works if the derive_more crate is an explicit dependency.

Modules§

ahash: A fast and DOS-resistent hash function, for use in HashMaps.
alloc: The Rust core allocation and collections library
anyhow: Flexible error handling.
axum: Web application framework based on tokio.
backtrace: Callstack backtraces on demand.
base64: Base64 encoding and decoding.
bindgen: Generate Rust bindings to C and C++ libraries.
bitflags: Types in which the bits are individually addressable.
blake3: The BLAKE3 cryptographic hash function.
bytes: Efficient byte buffer management.
cc: A basic cross-platform C compiler driver.
cfg_if: A macro for writing conditional compilation as if / else blocks.
chrono: Date and time library.
clap: Command line argument parsing.
core: The Rust Core Library
crossbeam: Concurrency tools to supplement std::sync, including fast channels.
ctrlc: Simple handling of CTRL-C for CLI programs.
cxx: C++ bridge runtime support; paired with cxx_build.
cxx_build: C++ bridge generator; paired with cxx.
derive_more: Derive implementations for common traits.
env_logger: A simple logger that can be configured via environment variables.
extension_trait: A macro for defining extension methods to external types.
extras: Additional tidbits defined by rmx.
flate2: Deflate, gzip, and zlib compression.
futures: Async programming primitives and utilities.
glob: Unix shell style pattern matching.
hex: Hexadecimal encoding and decoding.
http: Shared definitions related to the HTTP protocol.
hyper: HTTP, versions 1 and 2.
itertools: Extra iterator methods and utilities.
jiff: Modern date and time library.
json5: JSON5, a superset of JSON with expanded syntax.
libc: Bindings to the C standard library.
log: A lightweight logging facade for Rust.
mime: MIME type parsing and manipulation.
nom: Parser combinator library for building zero-copy parsers.
num_bigint: Arbitrary precision integers.
num_cpus: Get the number of CPUS on a machine.
num_enum: Type-safe conversions between enums and primitive numbers.
powerletters: Concise single-letter methods for common operations.
prelude: The rmx prelude.
proc_macro: A support library for macro authors when defining new macros.
proc_macro2: A preferred wrapper around the standard proc_macro crate.
proptest: Property-based testing framework for Rust.
quote: The quote! macro for turning code blocks into source tokens.
rand: Random number generation.
rand_chacha: The ChaCha cryptographically-secure random number generators.
rand_pcg: The PCG non-cryptographically-secure random number generators.
rayon: Data parallelism library for Rust.
regex: Regular expression engine with support for Unicode.
reqwest: Simple HTTP requests, synchronous and asynchronous.
rustyline: Command-line input reading with history.
semver: Semantic version parsing and comparison.
serde: Serialization and deserialization framework.
serde_json: JSON serialization and deserialization.
sha2: The SHA-2 cryptographic hash functions.
socket2: Low-level network socket programming beyond std::net.
static_assertions: Compile-time assertions about constants, types, and more.
std: The Rust Standard Library
syn: A Rust parser used by procedural macros.
tempfile: Temporary files and directories with automatic cleanup.
tera: A text template engine based on Jinja2.
termcolor: Cross-platform library for writing colored output to the terminal.
thiserror: Tools for defining custom error types.
tokio: Asynchronous runtime for writing reliable network applications.
toml: TOML parsing and serialization.
tower: Service request/response abstraction (HTTP middleware) for tokio and axum.
unicode_segmentation: Splitting strings on grapheme cluster, word, and sentence boundaries.
url: URL parsing and manipulation.
walkdir: Efficient directory traversal.
xshell: A Swiss-army knife for writing shell-style scripts in Rust.

Macros§

bug: Like ‘unimplemented’ but shorter to type.

Crate rustmaxCopy item path

§Profiles

§🌎 Profile: rmx-profile-no-std

§Crates in rmx-profile-no-std

§🌎 Profile: rmx-profile-std

§Crates in rmx-profile-std

§🌎 Profile: rmx-profile-wasm

§Crates in rmx-profile-wasm

§🌎 Profile: rmx-profile-net

§Crates in rmx-profile-net

§🌎 Profile: rmx-profile-cli

§Crates in rmx-profile-cli

§🌎 Profile: rmx-profile-build-script

§Crates in rmx-profile-build-script

§🌎 Profile: rmx-profile-proc-macro

§Crates in rmx-profile-proc-macro

§🌎 Profile: rmx-profile-full

§🌎 Profile: rmx-profile-max

§🌎 Profile: rmx-profile-max-nightly

§Ecosystem features

§⛲ Feature: rmx-feature-no-std

§⛲ Feature: rmx-feature-std

§⛲ Feature: rmx-feature-std-wasm

§⛲ Feature: rmx-feature-default

§⛲ Feature: rmx-feature-default-wasm

§⛲ Feature: rmx-feature-more

§⛲ Feature: rmx-feature-more-wasm

§⛲ Feature: rmx-feature-derive

§⛲ Feature: rmx-feature-serde

§⛲ Feature: rmx-feature-backtrace

§⛲ Feature: rmx-feature-tokio

§⛲Feature: rmx-feature-nightly

§Rust standard libraries

§📙 Rustlib: rmx-rustlibs-no-std

§📙 Rustlib: rmx-rustlibs-alloc

§📙 Rustlib: rmx-rustlibs-std

§📙 Rustlib: rmx-rustlibs-proc-macro

§Using rustmax as a library.

§rustmax and cargo features

§Crate reexports

§The rustmax prelude

§The extras module

§Known bugs

Modules§

Macros§

Crate rustmax

§🌎 Profile: `rmx-profile-no-std`

§Crates in `rmx-profile-no-std`

§🌎 Profile: `rmx-profile-std`

§Crates in `rmx-profile-std`

§🌎 Profile: `rmx-profile-wasm`

§Crates in `rmx-profile-wasm`

§🌎 Profile: `rmx-profile-net`

§Crates in `rmx-profile-net`

§🌎 Profile: `rmx-profile-cli`

§Crates in `rmx-profile-cli`

§🌎 Profile: `rmx-profile-build-script`

§Crates in `rmx-profile-build-script`

§🌎 Profile: `rmx-profile-proc-macro`

§Crates in `rmx-profile-proc-macro`

§🌎 Profile: `rmx-profile-full`

§🌎 Profile: `rmx-profile-max`

§🌎 Profile: `rmx-profile-max-nightly`

§⛲ Feature: `rmx-feature-no-std`

§⛲ Feature: `rmx-feature-std`

§⛲ Feature: `rmx-feature-std-wasm`

§⛲ Feature: `rmx-feature-default`

§⛲ Feature: `rmx-feature-default-wasm`

§⛲ Feature: `rmx-feature-more`

§⛲ Feature: `rmx-feature-more-wasm`

§⛲ Feature: `rmx-feature-derive`

§⛲ Feature: `rmx-feature-serde`

§⛲ Feature: `rmx-feature-backtrace`

§⛲ Feature: `rmx-feature-tokio`

§⛲Feature: `rmx-feature-nightly`

§📙 Rustlib: `rmx-rustlibs-no-std`

§📙 Rustlib: `rmx-rustlibs-alloc`

§📙 Rustlib: `rmx-rustlibs-std`

§📙 Rustlib: `rmx-rustlibs-proc-macro`

§Using `rustmax` as a library.

§`rustmax` and cargo features

§The `rustmax` prelude

§The `extras` module