Struct ChatEngineModule 

pub struct ChatEngineModule { /* private fields */ }

Chat Engine module entrypoint.

Construction is two-phased so the macro-generated registrator can instantiate the struct with ChatEngineModule::new() before Gear::init runs. All runtime handles live behind a OnceLock that is populated inside init() once the GearCtx is available.

Implementations

impl ChatEngineModule

pub const MODULE_NAME: &'static str = "chat-engine"

impl ChatEngineModule

pub fn into_gear(self) -> WithLifecycle<Self>

Wrap this instance into a stateful gear with lifecycle configuration.

impl ChatEngineModule

pub fn new() -> Self

Construct an uninitialised module. The macro-generated registrator uses this at link time; production wiring (config load, repo / service construction, ClientHub registration) runs in Gear::init.

pub async fn serve( self: Arc<Self>, cancel: CancellationToken, ready: ReadySignal, ) -> Result<()>

Lifecycle entry — periodic retention cleanup, gated by leader election.

The per-tenant sweep is wrapped in LeaderElector::run_role so that under horizontal scaling (@cpt-cf-chat-engine-adr-stateless-scaling) only the lease holder runs it — every replica running the full sweep concurrently would duplicate work, and the per-tenant advisory lock the cleanup relies on is a no-op on the SQLite path. Single-process / non-k8s builds use the noop elector (always leader), preserving the original behaviour.

ready.notify() fires before entering run_role: readiness gates dependent gears, not leadership, so a follower replica that never wins the lease is still “ready”. On lease loss the work token is cancelled mid-loop and the elector re-campaigns; cancel (gear shutdown) tears the whole thing down.

Trait Implementations

impl DatabaseCapability for ChatEngineModule

fn migrations(&self) -> Vec<Box<dyn MigrationTrait>>

impl Default for ChatEngineModule

fn default() -> Self

Returns the “default value” for a type.

impl Gear for ChatEngineModule

fn init<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 GearCtx, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl RestApiCapability for ChatEngineModule

fn register_rest( &self, _ctx: &GearCtx, router: Router, openapi: &dyn OpenApiRegistry, ) -> Result<Router>

Register REST routes for this gear.

fn healthcheck(&self, _ctx: &GearCtx) -> Option<Arc<dyn Healthcheck>>

Readiness healthcheck for this gear, run on every /readyz and /health. None (default) opts out.

impl Runnable for ChatEngineModule

fn run<'async_trait>( self: Arc<Self>, cancel: CancellationToken, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait,

Long-running loop. Must return when cancel is cancelled.