Skip to main content

DynamicModule

Struct DynamicModule 

Source
pub struct DynamicModule { /* private fields */ }
Expand description

Runtime-built module for configuration-driven imports and providers.

Implementations§

Source§

impl DynamicModule

Source

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

Source

pub fn import<M>(self, module: M) -> Self
where M: Module,

Source

pub fn import_arc(self, module: Arc<dyn Module>) -> Self

Source

pub fn forward_import<M>(self, module: M) -> Self
where M: Module,

Source

pub fn forward_import_arc(self, module: Arc<dyn Module>) -> Self

Source

pub fn provider(self, provider: ProviderDefinition) -> Self

Source

pub fn export<T>(self) -> Self
where T: Send + Sync + 'static,

Source

pub fn export_named(self, token: impl Into<String>) -> Self

Source

pub fn export_token(self, token: ProviderToken) -> Self

Source

pub fn middleware<M>(self, middleware: M) -> Self
where M: Middleware,

Source

pub fn middleware_arc(self, middleware: Arc<dyn Middleware>) -> Self

Source

pub fn configure_middleware<F>(self, configure: F) -> Result<Self>
where F: FnOnce(&mut MiddlewareConsumer) -> Result<()>,

Source

pub fn controller(self, controller: ControllerDefinition) -> Self

Source

pub fn route(self, route: RouteDefinition) -> Self

Source

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

Source

pub fn gateway(self, gateway: WebSocketGatewayDefinition) -> Self

Source

pub fn message_pattern(self, pattern: MessagePatternDefinition) -> Self

Source

pub fn global(self) -> Self

Trait Implementations§

Source§

impl Clone for DynamicModule

Source§

fn clone(&self) -> DynamicModule

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Module for DynamicModule

Source§

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

Stable module name used for deduplication and diagnostics.
Source§

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

Imported modules that should be registered before this module.
Source§

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

Forward module imports for intentional circular module relationships. Read more
Source§

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

Providers exported into the application container.
Source§

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

Providers this module exposes to importing modules.
Source§

fn is_global(&self) -> bool

Whether exported providers should be visible to every module scope.
Source§

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

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

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

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

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

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

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

Controller route groups built with access to the provider container.
Source§

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

Framework-neutral routes contributed directly by this module.
Source§

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

WebSocket gateways contributed by this module.
Source§

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

Microservice message patterns contributed by this module.
Source§

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

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

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

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

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

Lifecycle hook called after imports and providers are registered.
Source§

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

Async lifecycle hook called when shutdown begins.
Source§

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.
Source§

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

Signal-aware variant of Module::on_application_shutdown.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more