Struct ModuleCtx 

pub struct ModuleCtx { /* private fields */ }

Implementations

impl ModuleCtx

pub fn new( module_name: impl Into<Arc<str>>, instance_id: Uuid, config_provider: Arc<dyn ConfigProvider>, client_hub: Arc<ClientHub>, cancellation_token: CancellationToken, db: Option<DBProvider<DbError>>, ) -> Self

Create a new module-scoped context with all required fields.

pub fn module_name(&self) -> &str

pub fn instance_id(&self) -> Uuid

Returns the process-level instance ID.

This is a unique identifier for this process instance, shared by all modules in the same process. It is generated once at bootstrap.

pub fn config_provider(&self) -> &dyn ConfigProvider

pub fn client_hub(&self) -> Arc<ClientHub>

Get the ClientHub for dependency resolution.

pub fn cancellation_token(&self) -> &CancellationToken

pub fn db(&self) -> Option<DBProvider<DbError>>

Get a module-scoped DB entrypoint for secure database operations.

Returns None if no database is configured for this module.

Security

The returned DBProvider<modkit_db::DbError>:

• Is cheap to clone (shares an internal Db)
• Provides conn() for non-transactional access (fails inside tx via guard)
• Provides transaction(..) for transactional operations

Example

let db = ctx.db().ok_or_else(|| anyhow!("no db"))?;
let conn = db.conn()?;
let user = svc.get_user(&conn, &scope, id).await?;

pub fn db_required(&self) -> Result<DBProvider<DbError>>

Get a database handle, returning an error if not configured.

This is a convenience method that combines db() with an error for modules that require database access.

Errors

Returns an error if the database is not configured for this module.

Example

let db = ctx.db_required()?;
let conn = db.conn()?;
let user = svc.get_user(&conn, &scope, id).await?;

pub fn current_module(&self) -> Option<&str>

pub fn config<T: DeserializeOwned + Default>(&self) -> Result<T, ConfigError>

Deserialize the module’s config section into T, or use defaults if missing.

This method uses lenient configuration loading: if the module is not present in config, has no config section, or the module entry is not an object, it returns T::default(). This allows modules to exist without configuration sections in the main config file.

It extracts the ‘config’ field from: modules.<name> = { database: ..., config: ... }

Example

#[derive(serde::Deserialize, Default)]
struct MyConfig {
    api_key: String,
    timeout_ms: u64,
}

let config: MyConfig = ctx.config()?;

Errors

Returns ConfigError if deserialization fails.

pub fn raw_config(&self) -> &Value

Get the raw JSON value of the module’s config section. Returns the ‘config’ field from: modules. = { database: …, config: … }

pub fn without_db(&self) -> ModuleCtx

Create a derivative context with the same references but no DB handle. Useful for modules that don’t require database access.

Trait Implementations

impl Clone for ModuleCtx

fn clone(&self) -> ModuleCtx

Returns a duplicate of the value.

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

Performs copy-assignment from source.