Struct PluginRegistry 

pub struct PluginRegistry { /* private fields */ }

A registry of connector factories keyed by their YAML type: string.

The built-in connectors are dispatched by a compile-time match (gated by the source-* / sink-* Cargo features); this registry holds only the third-party connectors a custom-CLI author registers on top. The two are merged transparently — build_source / source_schema / source_descriptions (and their sink counterparts) consult the registered customs first and fall back to the built-in match, so a custom connector is usable from faucet.yaml exactly like a built-in one, across every command (run, validate, schema, list, preview, serve, …).

Example

use faucet_cli::registry::PluginRegistry;
let registry = PluginRegistry::with_builtins()
    .register_source("my", |cfg| Ok(Box::new(MySource::from_value(cfg)?)));
faucet_cli::run_main(registry);

Implementations

impl PluginRegistry

pub fn new() -> Self

An empty registry. Custom connectors registered on top of the built-ins.

pub fn with_builtins() -> Self

A registry seeded with the built-in connectors. The built-ins are dispatched by the compile-time match, so this is currently equivalent to PluginRegistry::new — but it is the canonical constructor a custom main.rs should call so that future changes to how built-ins are registered are picked up automatically.

pub fn register_source<F>(self, name: &str, factory: F) -> Self

where F: Fn(Value) -> CliResult<Box<dyn Source>> + Send + Sync + 'static,

Register a custom source connector under name (its YAML type:). Chainable. A collision with a built-in or a previously-registered custom name is recorded and surfaced by install.

pub fn register_source_with<F, S>( self, name: &str, factory: F, schema: S, description: &str, ) -> Self

where F: Fn(Value) -> CliResult<Box<dyn Source>> + Send + Sync + 'static, S: Fn() -> Value + Send + Sync + 'static,

Register a custom source with an explicit schema closure and one-line description (shown by faucet list and faucet schema source <name>).

pub fn register_sink<F>(self, name: &str, factory: F) -> Self

where F: Fn(Value) -> CliResult<Box<dyn Sink>> + Send + Sync + 'static,

Register a custom sink connector under name (its YAML type:).

pub fn register_sink_with<F, S>( self, name: &str, factory: F, schema: S, description: &str, ) -> Self

where F: Fn(Value) -> CliResult<Box<dyn Sink>> + Send + Sync + 'static, S: Fn() -> Value + Send + Sync + 'static,

Register a custom sink with an explicit schema closure and description.

pub fn install(self) -> CliResult<()>

Install this registry as the process-global custom-connector registry. Called once by crate::run_main. Returns an error if any register_* call collided, or if a registry was already installed.

Trait Implementations

impl Default for PluginRegistry

fn default() -> PluginRegistry

Returns the “default value” for a type.