qubit-spi 0.2.1

Typed service provider registry infrastructure for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

/*******************************************************************************
 *
 *    Copyright (c) 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
//! Runtime availability state for service providers.

/// Availability of a provider in the current runtime environment.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ProviderAvailability {
    /// The provider can create service instances.
    Available,
    /// The provider cannot create service instances.
    Unavailable {
        /// Human-readable reason explaining why the provider is unavailable.
        reason: String,
    },
}

impl ProviderAvailability {
    /// Creates an unavailable state with a human-readable reason.
    ///
    /// # Parameters
    /// - `reason`: Reason shown to callers when the provider cannot be used.
    ///
    /// # Returns
    /// Unavailable provider state.
    #[inline]
    pub fn unavailable(reason: &str) -> Self {
        Self::Unavailable {
            reason: reason.to_owned(),
        }
    }

    /// Tells whether this state allows service creation.
    ///
    /// # Returns
    /// `true` when the provider is available.
    #[inline]
    pub fn is_available(&self) -> bool {
        matches!(self, Self::Available)
    }
}