elme-rs

A set of crates providing glue code for Rust applications.

crates.io | Docs | GitHub

Certified Non AI Slop

Each crate in the elme framework was crafted by hand keyboard with care.

I take personal credit for the (hopefully) rare case where you believe some code to be of a sloppy nature.

For these cases, please open an issue or submit a PR - it's very much appreciated!

• elme
• elme-config
• elme-db
• elme-error
• elme-otel
• elme-shutdown

By default, elme ships with 0 dependencies and all modules disabled.

Modules can be enabled via feature flags:

cargo add elme --features [module_name]

Cargo.toml example

[dependencies]
elme = { version = "0.0.1", features = ["config","shutdown"] }

Note

---

Opting into modules using feature flags via the elme crate provides identical performance to manually depending on each module's respective crate.

Therefore, depending on the elme crate as opposed to depending on each respective module crate is the recommended versioning strategy.

Module re-exports - each module is gated by a feature flag.

This is the the recommended method of integrating elme modules.

crates.io | Docs | GitHub

See the following list for feature flags relevant to each module.

elme-config is a very small convenience module.

Supported features:

• A ConfigureApp trait for an app's root config struct
  • Contains default impl of a load() method, reading vals from .env files + env vars
  • Replaces the need for any and all config logic in standard cases
• Pulls in config and dotenvy deps, removing one-off dependency burden

crates.io | Docs | GitHub

Provides types supporting:

• Managed/unmanaged database wrapper structs
  • Managed db's are a superset of unmanaged w/ migration support
  • Can optionally be used to scope query availability in associated Repo impl's, e.g.
    1. Restrict repos backed by an UnmanagedDatabase to read-only queries (select, count, etc)
    2. Provide additional access to mutable queries when the Repo is backed with a ManagedDatabase
• Managed/unmanaged db config with types automatically mapped to PgPoolOptions

And provides utility traits supporting:

• Repo trait provides repository pattern on a per-table basis, with associated Row types and a clean interface
• Common query operations (insert one, insert many, etc) [db-op-traits feature only]
  • Boilerplate logic auto impl'd, simply provide the statement and query.bind() call
  • Allows for inline chaining of queries - with optional, automatic tx commit/rollback handling

crates.io | Docs | GitHub

Provides types for propagating errors, spantraces, and backtraces.

Similar functionality to eyre, color-eyre, anyhow, etc - with the following additions:

• Configuration of backtrace/spantrace format/visibility on a per-destination basis.
• Configuration of ANSI/color output on a per-destination basis.

For example, this could allow for the following (simultaneously):

• Output error messages with color backtraces in full to terminal
• Output error messages with non-color backtraces in full to a file
• Output error message strings to OTEL - with backtraces embedded in structured attra/metadata as opposed to the body

crates.io | Docs | GitHub

Dead simple, frustration-free OpenTelemetry bootstrapping.

crates.io | Docs | GitHub

Please forward any letters of gratitude generated by the dependencies section of your Cargo.toml file to our receiving dept.

Zero-effort lifecycle management: graceful shutdown, signal handling, task tracking, and more.

crates.io | Docs | GitHub