Struct rocket_db_pools::Initializer

pub struct Initializer<D: Database>(_, _);

A Fairing which initializes a Database and its connection pool.

A value of this type can be created for any type D that implements Database via the Database::init() method on the type. Normally, a value of this type never needs to be constructed directly. This documentation exists purely as a reference.

This fairing initializes a database pool. Specifically, it:

1. Reads the configuration at database.db_name, where db_name is Database::NAME.

2. Sets Config defaults on the configuration figment.

3. Calls Pool::init().

4. Stores the database instance in managed storage, retrievable via Database::fetch().

The name of the fairing itself is Initializer<D>, with D replaced with the type name D unless a name is explicitly provided via Self::with_name().

Implementations

impl<D: Database> Initializer<D>

pub fn new() -> Self

Returns a database initializer fairing for D.

This method should never need to be called manually. See the crate docs for usage information.

pub fn with_name(name: &'static str) -> Self

Returns a database initializer fairing for D with name name.

This method should never need to be called manually. See the crate docs for usage information.

Trait Implementations

impl<D: Database> Fairing for Initializer<D>

fn info(&self) -> Info

Returns an Info structure containing the name and Kind of this fairing. The name can be any arbitrary string. Kind must be an ord set of Kind variants.

fn on_ignite<'life0, 'async_trait>(
    &'life0 self,
    rocket: Rocket<Build>
) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

The ignite callback. Returns Ok if ignition should proceed and Err if ignition and launch should be aborted.

fn on_liftoff<'life0, 'life1, 'async_trait>(
    &'life0 self,
    _rocket: &'life1 Rocket<Orbit>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

The liftoff callback.

fn on_request<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
    &'life0 self,
    _req: &'life1 mut Request<'life2>,
    _data: &'life3 mut Data<'life4>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    'life4: 'async_trait,
    Self: 'async_trait, 

The request callback.

fn on_response<'r, 'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    _req: &'r Request<'life1>,
    _res: &'life2 mut Response<'r>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
    'r: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

The response callback.

fn on_shutdown<'life0, 'life1, 'async_trait>(
    &'life0 self,
    _rocket: &'life1 Rocket<Orbit>
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

The shutdown callback.