ferrunix 0.3.4

A lightweight run-time dependency injection framework for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

<div align="center">
  <h1>Ferrunix</h1>
  <p>
    <strong>A simple, idiomatic, and lightweight <a href="https://en.wikipedia.org/wiki/Dependency_injection">dependency injection</a> framework for Rust.</strong>
  </p>
  <p>

[![Build Status](https://github.com/leandros/ferrunix/actions/workflows/ci.yml/badge.svg)](https://github.com/leandros/ferrunix/actions)
[![Crates.io](https://img.shields.io/crates/v/ferrunix.svg)](https://crates.io/crates/ferrunix)
[![API reference](https://docs.rs/ferrunix/badge.svg)](https://docs.rs/ferrunix/)
![MSRV](https://img.shields.io/crates/msrv/ferrunix)
![License](https://img.shields.io/crates/l/ferrunix.svg)

  </p>
</div>

```toml
[dependencies]
ferrunix = "0.3"
```

*Compiler support: requires rustc 1.70.0+*

**Check out the [User Guide](https://leandros.github.io/ferrunix/user-guide/first-steps.html).**


## 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](https://leandros.github.io/ferrunix/docs-default/ferrunix/)     |
| `multithread`       | [link to docs](https://leandros.github.io/ferrunix/docs-multithread/ferrunix/) |
| `tokio`             | [link to docs](https://leandros.github.io/ferrunix/docs-multithread/ferrunix/) |


## 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`](https://docs.rs/inventory/latest/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](https://blog.rust-lang.org/2023/12/21/async-fn-rpit-in-traits.html#whats-stabilizing).
- `tracing`: Enables support for [tracing](https://docs.rs/tracing/latest/tracing/index.html) and annotates all public functions with
    [`tracing::instrument`](https://docs.rs/tracing/latest/tracing/attr.instrument.html).

## Support

> Development of ferrunix is sponsored by [RagnarLab](https://ragnarlab.com). 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.](https://ragnarlab.com)

#### License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br>

<sub>
By contributing to this project (for example, through submitting a pull
request) you agree with the <a
href="https://github.com/Leandros/ferrunix/blob/master/Contributors-License-Agreement.md">individual
contributor license agreement</a>. Make sure to read and understand it.
</sub>