Skip to navigation

Generated from cargo doc --no-deps -p nemo-relay-builtins -p nemo-relay-diagnostics -p nemo-relay-logging -p nemo-relay-plugin-host -p nemo-relay-codecs -p nemo-relay -p nemo-relay-runtime -p nemo-relay-model-pricing -p nemo-relay-resource-metrics -p nemo-relay-observability -p nemo-relay-adaptive -p nemo-relay-pii-redaction -p nemo-relay-ffi -p nemo-relay-types -p nemo-relay-plugin -p nemo-relay-worker-proto -p nemo-relay-worker.

pub trait Plugin:
    Send
    + Sync
    + 'static {
    // Required methods
    fn plugin_kind(&self) -> &str;
    fn register<'a>(
        &'a self,
        config: &'a Map<String, Json>,
        ctx: &'a mut PluginContext,
    ) -> PluginFuture<'a, ()>;
​
    // Provided methods
    fn allows_multiple_components(&self) -> bool { ... }
    fn validate(&self, _config: &Map<String, Json>) -> Vec<ConfigDiagnostic> { ... }
}

Trait implemented by Rust out-of-process worker plugins.

Required Methods

plugin_kind

fn plugin_kind(&self) -> &str

Returns the unique plugin kind.

register

fn register<'a>(
    &'a self,
    config: &'a Map<String, Json>,
    ctx: &'a mut PluginContext,
) -> PluginFuture<'a, ()>

Registers callbacks into the worker context.

Provided Methods

allows_multiple_components

fn allows_multiple_components(&self) -> bool

Whether multiple configured components may use this plugin kind.

validate

fn validate(&self, _config: &Map<String, Json>) -> Vec<ConfigDiagnostic>

Validate one component before runtime registration.

Implementors