ferrunix

Crates.ioferrunix
lib.rsferrunix
version
sourcesrc
created_at2024-10-09 07:07:48.265781+00
updated_at2025-03-26 20:34:49.911857+00
descriptionA lightweight run-time dependency injection framework for Rust
homepagehttps://github.com/Leandros/ferrunix
repositoryhttps://github.com/Leandros/ferrunix
max_upload_size
id1402087
Cargo.toml error:TOML parse error at line 19, column 1 | 19 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
Arvid Gerstmann (Leandros)

documentation

README

Ferrunix

A simple, idiomatic, and lightweight dependency injection framework for Rust.

Build Status Crates.io API reference MSRV License

[dependencies]
ferrunix = "0.4"

Compiler support: requires rustc 1.70.0+

Check out the User Guide.

Documentation

Due to how the various features affect the public API of the library, the documentation is provided for each major feature separately.

Feature Flags Link to Documentation
none link to docs
multithread link to docs
tokio link to docs

Features

  • Can register and inject any type (incl. generics, types must be Send if the multithread feature is enabled, and Send + Sync if tokio is enabled).

  • Simple and elegant Rust API; making the derive macro purely optional.

  • Different dependency lifetimes:

    • Singleton: Only a single instance of the object is created.
    • Transient: A new instance is created for every request.

  • Dependency resolution happens at run time, making it possible to dynamically register types.

  • Injection of concrete value types (T), Box<T>, Rc<T>, and Arc<T>.

  • Derive macro (#[derive(Inject)]) to simplify registration.

  • Automatic registration of types, thanks to inventory.

  • One global registry; with support for multiple sub-registries.

Cargo Feature Flags

Ferrunix has the following features to enable further functionality. Features enabled by default are marked with *.

  • multithread: Enables support for accessing the registry from multiple threads. This adds a bound that all registered types must be Send.
  • derive (*): Enables support for the #[derive(Inject)] macro.
  • tokio: Enables support for async constructors. Bumps the MSRV up to 1.75.0 because some of the internal traits require RPITIT.
  • tracing: Enables support for tracing and annotates all public functions with tracing::instrument.

Support

Development of ferrunix is sponsored by RagnarLab. RagnarLab is a Rust consultancy based in Stuttgart, Germany. We provide Rust development from prototype to product, helping you write safer software. Interested in Rust? Get in touch with us.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
By contributing to this project (for example, through submitting a pull request) you agree with the individual contributor license agreement. Make sure to read and understand it.
Commit count: 118

cargo fmt