Trait Plugin

Source

pub trait Plugin: Send + Sync {
    // Required methods
    fn info(&self) -> &PluginInfo;
    fn state(&self) -> PluginState;
    fn init(&mut self) -> impl Future<Output = Result<(), IronpostError>> + Send;
    fn start(
        &mut self,
    ) -> impl Future<Output = Result<(), IronpostError>> + Send;
    fn stop(&mut self) -> impl Future<Output = Result<(), IronpostError>> + Send;
    fn health_check(&self) -> impl Future<Output = HealthStatus> + Send;
}

Expand description

모든 모듈이 구현하는 플러그인 trait

Pipeline의 상위 추상화로, 메타데이터 조회와 초기화 단계를 추가합니다.

§생명주기

Created → init() → Initialized → start() → Running → stop() → Stopped

§구현 예시

struct MyPlugin {
    info: PluginInfo,
    state: PluginState,
}

impl Plugin for MyPlugin {
    fn info(&self) -> &PluginInfo { &self.info }
    fn state(&self) -> PluginState { self.state }

    async fn init(&mut self) -> Result<(), IronpostError> {
        self.state = PluginState::Initialized;
        Ok(())
    }
    async fn start(&mut self) -> Result<(), IronpostError> {
        self.state = PluginState::Running;
        Ok(())
    }
    async fn stop(&mut self) -> Result<(), IronpostError> {
        self.state = PluginState::Stopped;
        Ok(())
    }
    async fn health_check(&self) -> HealthStatus {
        HealthStatus::Healthy
    }
}