Struct shaku_rocket::Inject

pub struct Inject<'r, M: ModuleInterface + HasComponent<I> + ?Sized, I: Interface + ?Sized>(_, _);

Used to retrieve a reference to a component from a shaku Module. The module should be stored in Rocket’s state, in a Box (It could be Box<dyn MyModule> if the module implementation changes at runtime). Use this Inject struct as a request guard.

Example

#[macro_use] extern crate rocket;

use shaku::{module, Component, Interface};
use shaku_rocket::Inject;

trait HelloWorld: Interface {
    fn greet(&self) -> String;
}

#[derive(Component)]
#[shaku(interface = HelloWorld)]
struct HelloWorldImpl;

impl HelloWorld for HelloWorldImpl {
    fn greet(&self) -> String {
        "Hello, world!".to_owned()
    }
}

module! {
    HelloModule {
        components = [HelloWorldImpl],
        providers = []
    }
}

#[get("/")]
fn hello(hello_world: Inject<HelloModule, dyn HelloWorld>) -> String {
    hello_world.greet()
}

#[rocket::launch]
fn rocket() -> _ {
    let module = HelloModule::builder().build();

    rocket::build()
        .manage(Box::new(module))
        .mount("/", routes![hello])
}

Trait Implementations

impl<'r, M: ModuleInterface + HasComponent<I> + ?Sized, I: Interface + ?Sized> Deref for Inject<'r, M, I>

type Target = I

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'r, M: ModuleInterface + HasComponent<I> + ?Sized, I: Interface + ?Sized> FromRequest<'r> for Inject<'r, M, I>

type Error = String

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>(
    request: &'r Request<'life0>
) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>> where
    'r: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Derives an instance of Self from the incoming request metadata.