Struct ModuleMetadata 

pub struct ModuleMetadata {
    pub imports: Vec<ModuleDef>,
    pub providers: Vec<ProviderDef>,
    pub controllers: Vec<ControllerDef>,
    pub event_handlers: Vec<EventHandlerDef>,
    pub gateways: Vec<GatewayDef>,
    pub microservices: Vec<MicroserviceDef>,
    /* private fields */
}

Re-exported public API. Public Caelix type ModuleMetadata.

Fields

imports: Vec<ModuleDef>

The imports value.

providers: Vec<ProviderDef>

The providers value.

controllers: Vec<ControllerDef>

The controllers value.

event_handlers: Vec<EventHandlerDef>

The event_handlers value.

gateways: Vec<GatewayDef>

The gateways value.

microservices: Vec<MicroserviceDef>

The dependency-injected microservice classes declared by this module.

Implementations

impl ModuleMetadata

pub fn new() -> Self

Runs the new public API operation.

pub fn global() -> Self

Creates metadata for a global module. Only explicitly exported providers become global.

pub fn import<M: Module + 'static>(self) -> Self

Runs the import public API operation.

pub fn provider<T: Injectable>(self) -> Self

Runs the provider public API operation.

pub fn provider_async_factory<T, Fut, E>( self, dependencies: Vec<ProviderDependency>, factory: impl Fn(Arc<Container>) -> Fut + Send + Sync + 'static, ) -> Self

where T: Send + Sync + 'static, Fut: Future<Output = Result<T, E>> + Send + 'static, E: Debug + Send + 'static,

Runs the provider_async_factory public API operation.

pub fn controller<C: Controller + Injectable + 'static>(self) -> Self

Runs the controller public API operation.

pub fn gateway<G: Gateway>(self) -> Self

Runs the gateway public API operation.

pub fn microservice<T: Microservice>(self) -> Self

Registers a dependency-injected microservice and all of its message handlers.

A microservice is already a provider; do not additionally register it with Self::provider.

pub fn event_handler<H>(self) -> Self

where H: RegisterableEventHandler + EventHandler<H::Event>,

Runs the event_handler public API operation.

pub fn event_handler_for<E, H>(self) -> Self

where E: Clone + Send + Sync + 'static, H: Injectable + EventHandler<E>,

Runs the event_handler_for public API operation.

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

Makes a locally declared provider, or a direct import’s export, available to importing modules.

Trait Implementations

impl Default for ModuleMetadata

fn default() -> Self

Returns the “default value” for a type.