4 releases

Uses new Rust 2021

0.1.3 Jun 14, 2022
0.1.2 Jun 9, 2022
0.1.1 Jun 9, 2022
0.1.0 Jun 9, 2022

#308 in Testing

Download history 62/week @ 2022-06-05 91/week @ 2022-06-12 252/week @ 2022-06-19 104/week @ 2022-06-26 104/week @ 2022-07-03 209/week @ 2022-07-10 147/week @ 2022-07-17 60/week @ 2022-07-24 146/week @ 2022-07-31 198/week @ 2022-08-07 161/week @ 2022-08-14 31/week @ 2022-08-21 155/week @ 2022-08-28 164/week @ 2022-09-04 191/week @ 2022-09-11 151/week @ 2022-09-18

662 downloads per month
Used in dose

GPL-3.0-only

6KB
111 lines

dose

Current Crates.io Version

Your daily dose of structs and functions.

Features

  • Simplicity 👌
  • Blazingly Fast 🏎️💨
  • Lazy Instantiation 🦥
  • Statically Checked 🕵️‍♀️
  • Dependency Injection 💉
  • Declarative Interface ✨
  • No Runtime Dependency Graph 🎉

Unfortunately we do not support runtime dependency cycle detection ... yet.

Usage

Initialization

You need to initialize the crate with the init! macro at the root of your project in lib.rs. This is a current limitation of rust and this may become unnecessary in future versions.

dose::init!();

Registering Providers

You can register providers with the provide attribute.

#[provide]
fn provide_something(context: &mut Context<Config>) -> Something {
    Something::new(...)
}

The &mut Context<Config> is always passed as argument and can be used to resolve other types. The config is also available from the context context.config.

Each time the type Something is get!, the function above will be called. If you want the same instance to be used, the attribute parameter singleton needs to be set to true.

#[provide(singleton=true)]
fn provide_something(context: &mut Context<Config>) -> Something {
    Something::new(...)
}

In this case, each time the type Something is get!, the instance will be cloned. This really becomes a singleton if type Something is wrapped in an std::sync::Arc or a std::rc::Rc.

#[provide(singleton=true)]
fn provide_something(context: &mut Context<Config>) -> Arc<Something> {
    Arc::new(Something::new(...))
}

Resolving Instances

The get! macro is the way to get the instance of a type.

let mut context = dose::Context::new(config);
let my_type: MyType = dose::get!(context);

This macro can also be used inside providers.

struct MyType {
    a: TypeA,
    b: TypeB,
}

#[provide]
fn provide_my_type(context: &mut Context<Config>) -> MyType {
    MyType {
        a: get!(context), // Type infered to TypeA
        b: get!(context), // Type infered to TypeB
    }
}

Note that if the provider of TypeA or TypeB is not registered, a compilation error will occur.

Good Practices

Module Separation

Providers should be defined in modules specifically created for declaring how each type is instantiated.

Context Lifecycle

The Context<Config> should be deleted (drop) before the application is started.

Using out of scope.

use dose::{Context, get}

... // declare all modules

fn create_server(config: Config) -> Server {
    let mut context = Context::new(config);
    get!(context) 
}

#[tokio::main]
async fn start_server_implicit() {
    let server = create_server(Config::load(...));
    // Implicitly drop the context because it becomes out of scope
    server.start().await
}

#[tokio::main]
async fn start_server_explicit() {
    let mut context = Context::new(config);
    let server: Server = get!(context);
    // Explicitly drop the context using std::mem::drop
    std::mem::drop(context);
    server.start().await
}

Providers Single Purpose

Keep providers simple, only creation logic should be in there. No algorithms or domain logic should be executed.

Config

The config provided in the context can be anything, but a simple struct without functions and public fields can be used. Each provider should only require the context and the config to execute properly.

Dependencies

~220–630KB
~15K SLoC