dd545441d3
* introduce rustfmt * Cargofmt on all sea-orm crates & examples * Revert testing script * cargo fmt --manifest-path sea-orm-rocket/Cargo.toml --all * add a script for formatting * add nightly component for formatting * set timeout and manual nightly install in github action * add flag for manifest-path Co-authored-by: Billy Chan <ccw.billy.123@gmail.com>
54 lines
1.8 KiB
Rust
54 lines
1.8 KiB
Rust
#![recursion_limit = "256"]
|
|
#![warn(rust_2018_idioms)]
|
|
|
|
//! # `sea_orm_rocket` - Code Generation
|
|
//!
|
|
//! Implements the code generation portion of the `sea_orm_rocket` crate. This
|
|
//! is an implementation detail. This create should never be depended on
|
|
//! directly.
|
|
|
|
#[macro_use]
|
|
extern crate quote;
|
|
|
|
mod database;
|
|
|
|
/// Automatic derive for the [`Database`] trait.
|
|
///
|
|
/// The derive generates an implementation of [`Database`] as follows:
|
|
///
|
|
/// * [`Database::NAME`] is set to the value in the `#[database("name")]`
|
|
/// attribute.
|
|
///
|
|
/// This names the database, providing an anchor to configure the database via
|
|
/// `Rocket.toml` or any other configuration source. Specifically, the
|
|
/// configuration in `databases.name` is used to configure the driver.
|
|
///
|
|
/// * [`Database::Pool`] is set to the wrapped type: `PoolType` above. The type
|
|
/// must implement [`Pool`].
|
|
///
|
|
/// To meet the required [`Database`] supertrait bounds, this derive also
|
|
/// generates implementations for:
|
|
///
|
|
/// * `From<Db::Pool>`
|
|
///
|
|
/// * `Deref<Target = Db::Pool>`
|
|
///
|
|
/// * `DerefMut<Target = Db::Pool>`
|
|
///
|
|
/// * `FromRequest<'_> for &Db`
|
|
///
|
|
/// * `Sentinel for &Db`
|
|
///
|
|
/// The `Deref` impls enable accessing the database pool directly from
|
|
/// references `&Db` or `&mut Db`. To force a dereference to the underlying
|
|
/// type, use `&db.0` or `&**db` or their `&mut` variants.
|
|
///
|
|
/// [`Database`]: ../sea_orm_rocket/trait.Database.html
|
|
/// [`Database::NAME`]: ../sea_orm_rocket/trait.Database.html#associatedconstant.NAME
|
|
/// [`Database::Pool`]: ../sea_orm_rocket/trait.Database.html#associatedtype.Pool
|
|
/// [`Pool`]: ../sea_orm_rocket/trait.Pool.html
|
|
#[proc_macro_derive(Database, attributes(database))]
|
|
pub fn derive_database(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
|
|
crate::database::derive_database(input)
|
|
}
|