The Module trait is the foundation for all modules in the iii framework. Every module must implement this trait to integrate with the engine’s lifecycle management, function registration, and background task execution.
Location
use iii::modules::module::Module;
src/modules/module.rs
Trait Definition
#[async_trait::async_trait]
pub trait Module: Send + Sync {
fn name(&self) -> &'static str;
async fn create(
engine: Arc<Engine>,
config: Option<Value>
) -> anyhow::Result<Box<dyn Module>>
where
Self: Sized;
fn make_module(
engine: Arc<Engine>,
config: Option<Value>
) -> ModuleFuture
where
Self: Sized + 'static;
async fn initialize(&self) -> anyhow::Result<()>;
async fn start_background_tasks(
&self,
_shutdown: tokio::sync::watch::Receiver<bool>,
) -> anyhow::Result<()>;
async fn destroy(&self) -> anyhow::Result<()>;
fn register_functions(&self, engine: Arc<Engine>);
}
Required Methods
name
fn name(&self) -> &'static str
The module’s name identifier
create
async fn create(
engine: Arc<Engine>,
config: Option<Value>
) -> anyhow::Result<Box<dyn Module>>
Reference to the iii engine instance
Optional JSON configuration for the module
return
anyhow::Result<Box<dyn Module>>
Returns a boxed module instance or an error
initialize
async fn initialize(&self) -> anyhow::Result<()>
Returns Ok(()) on success or an error
Optional Methods
make_module
fn make_module(
engine: Arc<Engine>,
config: Option<Value>
) -> ModuleFuture
create.
Reference to the iii engine instance
Optional JSON configuration for the module
A pinned future that resolves to a module instance
start_background_tasks
async fn start_background_tasks(
&self,
_shutdown: tokio::sync::watch::Receiver<bool>,
) -> anyhow::Result<()>
shutdown
tokio::sync::watch::Receiver<bool>
required
Shutdown signal receiver to gracefully stop background tasks
Returns Ok(()) on success or an error
destroy
async fn destroy(&self) -> anyhow::Result<()>
Returns Ok(()) on success or an error
register_functions
fn register_functions(&self, engine: Arc<Engine>)
#[service] macro.
Reference to the iii engine instance for function registration
Implementation Example
use std::sync::Arc;
use async_trait::async_trait;
use serde_json::Value;
use iii::{
engine::Engine,
modules::module::Module,
};
#[derive(Clone)]
pub struct KvServer {
storage: Arc<BuiltinKvStore>,
}
#[async_trait]
impl Module for KvServer {
fn name(&self) -> &'static str {
"KV Server"
}
async fn create(
_engine: Arc<Engine>,
config: Option<Value>,
) -> anyhow::Result<Box<dyn Module>> {
let storage = BuiltinKvStore::new(config);
let storage = Arc::new(storage);
Ok(Box::new(KvServer { storage }))
}
fn register_functions(&self, engine: Arc<Engine>) {
// Usually generated by #[service] macro
self.register_functions(engine);
}
async fn initialize(&self) -> anyhow::Result<()> {
Ok(())
}
}
ModuleFuture
type ModuleFuture = Pin<Box<dyn Future<Output = anyhow::Result<Box<dyn Module>>> + Send>>;
See Also