froodi 1.0.0-alpha.2

An ergonomic Rust IoC container
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# Froodi - an ergonomic Rust IoC container

[![Crates.io][crates-badge]][crates-url]

Froodi is a lightweight, ergonomic Inversion of Control (IoC) container for Rust that helps manage dependencies with clear scoping and lifecycle management in a simple manner

## Features

- **Scoping**: Any object can have a lifespan for the entire app, a single request, or even more fractionally
- **Finalization**: Some dependencies, like database connections, need not only to be created but also carefully released. Many frameworks lack this essential feature.
- **Ergonomic**: Simple API
- **Speed**: Dependency resolving as fast as the speed of light thanks to the Rust
- **Integration**: The popular frameworks for building applications is supported out of the box (axum, dptree)
- **Safe**: 100% safe Rust (no unsafe used)
- **Thread safe**: Thread safety enabled by default (`thread_safe` feature) and can be disabled to use `Rc` instead of `Arc` and off `Send`/`Sync` requirements

## Community
### Telegram
- 🇺🇸 🇷🇺 [@froodi_di](https://t.me/froodi_di)

# Quickstart
```rust
use froodi::{
    Container,
    DefaultScope::{App, Request},
    Inject, InjectTransient, InstantiatorResult, instance, registry,
};

#[derive(Default, Clone)]
struct Config {
    _host: &'static str,
    _port: i16,
    _user: &'static str,
    _password: &'static str,
    _db: &'static str,
}

trait UserRepo {
    fn create_user(&self);
}

struct PostgresUserRepo;

impl UserRepo for PostgresUserRepo {
    fn create_user(&self) {
        todo!()
    }
}

struct CreateUser<R> {
    repo: R,
}

impl<R: UserRepo> CreateUser<R> {
    fn handle(&self) {
        self.repo.create_user();
    }
}

fn init_container(config: Config) -> Container {
    #[allow(clippy::unnecessary_wraps)]
    fn create_user<R>(InjectTransient(repo): InjectTransient<R>) -> InstantiatorResult<CreateUser<R>> {
        Ok(CreateUser { repo })
    }

    Container::new(registry! {
        provide(App, instance(config)),
        scope(Request) [
            provide(|_config: Inject<Config>| Ok(PostgresUserRepo)),
            provide(create_user::<PostgresUserRepo>),
        ],
    })
}

fn main() {
    let app_container = init_container(Config::default());
    let request_container = app_container.clone().enter_build().unwrap();

    let interactor = request_container.get_transient::<CreateUser<PostgresUserRepo>>().unwrap();
    interactor.handle();

    let _config = request_container.get::<Config>().unwrap();

    request_container.close();
    app_container.close();
}
```

## Examples
 - [Sync provide][examples/sync_provide]. This example shows how to provide sync dependencies.
 - [Async provide][examples/async_provide]. This example shows how to provide async sync dependencies.
 - [Sync finalizer][examples/sync_finalizer]. This example shows how to add sync finalizers.
 - [Async finalizer][examples/async_finalizer]. This example shows how to add async finalizers.
 - [Boxed dyn provide][examples/box_dyn_provide]. This example shows how to provide boxed dyn dependencies.
 - [Axum][examples/axum]. This example shows how to integrate the framework with Axum library.
 - [Dptree][examples/dptree]. This example shows how to integrate the framework with Dptree library.
 - [Telers][examples/telers]. This example shows how to integrate the framework with Telers framework.

You may consider checking out [this directory][examples] for examples.

# Contributing

Contributions are welcome!

## License
[Apache License, Version 2.0][license_apache]

[examples]: https://github.com/Desiders/froodi/tree/master/examples
[examples/sync_provide]: https://github.com/Desiders/froodi/tree/master/examples/sync_provide
[examples/async_provide]: https://github.com/Desiders/froodi/tree/master/examples/async_provide
[examples/sync_finalizer]: https://github.com/Desiders/froodi/tree/master/examples/sync_finalizer
[examples/async_finalizer]: https://github.com/Desiders/froodi/tree/master/examples/async_finalizer
[examples/box_dyn_provide]: https://github.com/Desiders/froodi/tree/master/examples/box_dyn_provide
[examples/axum]: https://github.com/Desiders/froodi/tree/master/examples/axum
[examples/dptree]: https://github.com/Desiders/froodi/tree/master/examples/dptree
[examples/telers]: https://github.com/Desiders/froodi/tree/master/examples/telers

[license_apache]: https://github.com/Desiders/froodi/blob/master/froodi/LICENSE
[docs]: https://docs.rs/froodi
[crates-badge]: https://img.shields.io/crates/v/froodi.svg
[crates-url]: https://crates.io/crates/froodi