Struct ViewModule 

pub struct ViewModule { /* private fields */ }

Module that registers a ViewRenderer provider.

Implementations

impl ViewModule

pub fn new<E>(name: &'static str, engine: E) -> Self

where E: ViewEngine,

pub fn from_renderer(name: &'static str, renderer: ViewRenderer) -> Self

pub fn global(self) -> Self

pub fn renderer(&self) -> ViewRenderer

Trait Implementations

impl Clone for ViewModule

fn clone(&self) -> ViewModule

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ViewModule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Module for ViewModule

fn name(&self) -> &'static str

Stable module name used for deduplication and diagnostics.

fn providers(&self) -> Result<Vec<ProviderDefinition>>

Providers exported into the application container.

fn exports(&self) -> Result<Vec<ProviderToken>>

Providers this module exposes to importing modules.

fn is_global(&self) -> bool

Whether exported providers should be visible to every module scope.

fn imports(&self) -> Vec<Arc<dyn Module>>

Imported modules that should be registered before this module.

fn forward_imports(&self) -> Vec<Arc<dyn Module>>

Forward module imports for intentional circular module relationships.

fn route_prefix(&self) -> Option<&str>

Optional HTTP route prefix applied to controllers and direct routes in this module and its imports.

fn middleware(&self) -> Vec<Arc<dyn Middleware>>

Middleware applied to controllers and direct routes declared by this module.

fn configure( &self, _consumer: &mut MiddlewareConsumer, _module_ref: &ModuleRef, ) -> Result<()>

Configure route-scoped middleware with a Nest-style consumer.

fn controllers( &self, _module_ref: &ModuleRef, ) -> Result<Vec<ControllerDefinition>>

Controller route groups built with access to the provider container.

fn routes(&self) -> Result<Vec<RouteDefinition>>

Framework-neutral routes contributed directly by this module.

fn gateways( &self, _module_ref: &ModuleRef, ) -> Result<Vec<WebSocketGatewayDefinition>>

WebSocket gateways contributed by this module.

fn message_patterns( &self, _module_ref: &ModuleRef, ) -> Result<Vec<MessagePatternDefinition>>

Microservice message patterns contributed by this module.

fn on_module_init(&self, _module_ref: &ModuleRef) -> Result<()>

Lifecycle hook called after imports and providers are registered.

fn on_application_bootstrap( &self, _module_ref: ModuleRef, ) -> BoxFuture<'static, Result<()>>

Async lifecycle hook called by hosts that want startup work before serve.

fn on_module_destroy( &self, _module_ref: ModuleRef, _signal: Option<String>, ) -> BoxFuture<'static, Result<()>>

Async lifecycle hook called when shutdown begins.

fn before_application_shutdown( &self, _module_ref: ModuleRef, _signal: Option<String>, ) -> BoxFuture<'static, Result<()>>

Async lifecycle hook called after module destroy hooks and before final shutdown hooks.

fn on_application_shutdown( &self, _module_ref: ModuleRef, ) -> BoxFuture<'static, Result<()>>

Async lifecycle hook called by hosts that need graceful shutdown cleanup.

fn on_application_shutdown_with_signal( &self, module_ref: ModuleRef, _signal: Option<String>, ) -> BoxFuture<'static, Result<()>>

Signal-aware variant of Module::on_application_shutdown.