Skip to main content

qubit_spi/service/
provider_definition.rs

1// =============================================================================
2//    Copyright (c) 2025 - 2026 Haixing Hu.
3//
4//    SPDX-License-Identifier: Apache-2.0
5//
6//    Licensed under the Apache License, Version 2.0.
7// =============================================================================
8//! Self-described providers accepted by a provider registry.
9
10use crate::ProviderMetadata;
11use crate::ServiceProvider;
12use crate::SyncServiceSpec;
13
14/// Marker combining synchronous creation with registration metadata.
15///
16/// Every type implementing both [`ProviderMetadata`] and
17/// [`ServiceProvider<S>`] automatically implements this trait.
18///
19/// # Type Parameters
20///
21/// * `S` - Synchronous service family implemented by the provider.
22///
23/// # Examples
24///
25/// ```rust
26/// use qubit_spi::{ServiceSpec, SyncServiceSpec};
27/// struct Spec;
28/// impl ServiceSpec for Spec {
29///     type Config = String;
30///     type Error = std::io::Error;
31/// }
32/// impl SyncServiceSpec for Spec { type Output = String; }
33/// use qubit_spi::{ProviderDescriptor, ProviderId, ProviderMetadata, ServiceProvider};
34/// use qubit_spi::error::ProviderFailure;
35/// struct Echo;
36/// impl ProviderMetadata for Echo {
37///     fn descriptor(&self) -> ProviderDescriptor {
38///         ProviderDescriptor::new(ProviderId::new("echo").expect("valid static ID"))
39///     }
40/// }
41/// impl ServiceProvider<Spec> for Echo {
42///     fn create_configured(&self, config: &String) -> Result<String, ProviderFailure<std::io::Error>> {
43///         Ok(config.clone())
44///     }
45/// }
46/// let provider: std::sync::Arc<dyn qubit_spi::ProviderDefinition<Spec>> = std::sync::Arc::new(Echo);
47/// assert_eq!("echo", provider.descriptor().id().as_str());
48/// assert_eq!("hello", provider.create_configured(&"hello".to_owned())?);
49/// # Ok::<(), Box<dyn std::error::Error>>(())
50/// ```
51pub trait ProviderDefinition<S>: ProviderMetadata + ServiceProvider<S>
52where
53    S: SyncServiceSpec,
54{
55    // empty
56}
57
58impl<S, T> ProviderDefinition<S> for T
59where
60    S: SyncServiceSpec,
61    T: ProviderMetadata + ServiceProvider<S> + ?Sized,
62{
63    // empty
64}