sword 0.2.1

Structured web framework built on top of tokio ecosystem, providing powerful features for building robust web applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

use crate::adapters::AdapterRegistry;
use sword_core::{ComponentRegistry, Config, ProviderRegistry};

/// A trait for defining modules in the application.
///
/// `Module` represents a cohesive unit of functionality that can be
/// plugged into the application. Modules can register adapters,
/// components, and providers to extend the application's capabilities.
///
/// # Example
///
/// ```rust,ignore
/// use sword::prelude::*;
///
/// pub struct MyModule;
///
/// impl Module for MyModule {
///     fn register_adapters(adapters: &AdapterRegistry) {
///         adapters.register::<MyController>();  // Register HTTP controller
///     }
///
///     fn register_components(container: &DependencyContainer) {
///         container.register_component::<MyService>();
///     }
///
///     async fn register_providers(config: &Config, container: &DependencyContainer) {
///         container.register_provider(MyProvider::new().await);
///     }
/// }
/// ```
#[allow(async_fn_in_trait)]
#[allow(unused_variables)]
pub trait Module {
    /// Register adapters provided by the module.
    /// A `Adapter` is a way to represent entry points into the application,
    /// such as HTTP controllers, Socket.IO Handlers, or gRPC services.
    fn register_adapters(adapters: &AdapterRegistry) {}

    /// Register component structs marked with `#[injectable]`
    fn register_components(components: &ComponentRegistry) {}

    /// Register provider structs marked with `#[injectable(provider)]`
    async fn register_providers(config: &Config, providers: &ProviderRegistry) {}
}