Struct NestForgeFactory 

pub struct NestForgeFactory<M: ModuleDefinition> { /* private fields */ }

The main entry point for creating a NestForge application.

It handles the bootstrap process:

1. Creating the DI Container.
2. Initializing the Module Graph (resolving imports and providers).
3. Merging all Controller routers into a single Axum app.
4. Attaching global middleware, guards, interceptors, and exception filters.

Example

use nestforge_http::NestForgeFactory;

#[tokio::main]
async fn main() {
    let app = NestForgeFactory::<AppModule>::create()
        .expect("failed to start")
        .listen(3000)
        .await;
}

Implementations

impl<M: ModuleDefinition> NestForgeFactory<M>

pub fn create() -> Result<Self>

Creates a new application instance from the root module.

This triggers the DI container initialization and module lifecycle hooks (e.g., on_module_init).

pub fn with_global_prefix(self, prefix: impl Into<String>) -> Self

Sets a global prefix for all routes (e.g., “api”).

pub fn with_version(self, version: impl Into<String>) -> Self

Sets a global API version for all routes (e.g., “v1”).

pub fn use_guard<G>(self) -> Self

where G: Guard + Default,

Registers a global guard.

Global guards run for every route in the application.

pub fn use_interceptor<I>(self) -> Self

where I: Interceptor + Default,

Registers a global interceptor.

Global interceptors wrap every route handler.

pub fn use_exception_filter<F>(self) -> Self

where F: ExceptionFilter + Default,

Registers a global exception filter.

Catches unhandled exceptions from any route.

pub fn use_middleware<T>(self) -> Self

where T: NestMiddleware + Default,

Applies middleware to the application.

Use the builder to select which routes the middleware applies to.

pub fn configure_middleware<F>(self, configure: F) -> Self

where F: FnOnce(&mut MiddlewareConsumer),

Advanced middleware configuration using a consumer builder.

pub fn with_auth_resolver<F, Fut>(self, resolver: F) -> Self

where F: Fn(Option<String>, Container) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Option<AuthIdentity>, HttpException>> + Send + 'static,

Sets the authentication resolver.

This function is called for every request to resolve the AuthIdentity from the bearer token.

pub fn merge_router(self, router: Router<Container>) -> Self

Merges an external Axum router into the application.

Useful for integrating other libraries or raw Axum handlers.

pub fn container(&self) -> &Container

Returns a reference to the underlying DI Container.

pub fn into_router(self) -> Router

Consumes the factory and returns the fully configured Axum Router.

Use this if you want to run the app with your own server (e.g. Lambda, Shuttle).

pub async fn listen(self, port: u16) -> Result<()>

Starts the HTTP server on the specified port.

This will block the current thread (it should be awaited). Upon shutdown (Ctrl+C), it runs the on_module_destroy and on_application_shutdown hooks.