Struct ProviderRegistry 

pub struct ProviderRegistry { /* private fields */ }

Stable since 0.63.0

Provider trait, streaming options, and provider registry. Runtime registry for providers (custom + built-in resolution).

This is an instance-based alternative to the global CUSTOM_PROVIDERS static. It supports register(), get(), remove(), and names(), falling back to built-in providers from the built-in provider factory when a name isn’t found locally.

Providers can also be registered as factories via Self::register_factory. A factory is a closure that lazily creates the provider on first access. The result is cached, so the factory runs at most once per name.

Implementations

impl ProviderRegistry

pub fn new() -> Self

Create a new empty registry.

pub fn register(&self, name: &str, provider: impl Provider + 'static)

Register a custom provider.

pub fn register_arc(&self, name: &str, provider: Arc<dyn Provider>)

Register a pre-boxed provider.

pub fn remove(&self, name: &str)

Remove a previously registered custom provider.

pub fn names(&self) -> Vec<String>

Return the set of currently registered custom provider names.

pub fn get(&self, name: &str) -> Option<Arc<dyn Provider>>

Get a provider by name.

Checks local custom providers first, then falls back to built-in providers.

pub fn get_custom(&self, name: &str) -> Option<Arc<dyn Provider>>

Get a provider by name, checking only custom providers (no built-in fallback).

If the provider was registered via Self::register_factory and hasn’t been materialized yet, the factory is invoked and the result cached.

pub fn register_factory( &self, name: &str, factory: impl Fn() -> Result<Arc<dyn Provider>> + Send + Sync + 'static, )

Register a factory closure that lazily creates a provider on first access.

When Self::get_custom or Self::get is called and the provider is not yet in custom, the factory is invoked, the result is cached in custom, and the factory entry is removed.

Example

registry.register_factory("my_provider", || {
    let key = resolve_api_key("my_provider");
    Ok(Arc::new(MyProvider::new(key)))
});

Trait Implementations

impl Default for ProviderRegistry

fn default() -> Self

Returns the “default value” for a type.