Enum ApiKeySource 

pub enum ApiKeySource {
    Static(SecretString),
    Dynamic(Arc<ApiKeyProvider>),
    AsyncDynamic(Arc<AsyncApiKeyProvider>),
}

表示客户端使用的 API Key 来源。

Variants

Static(SecretString)

使用固定字符串作为 API Key。

Dynamic(Arc<ApiKeyProvider>)

每次请求或重试时动态生成 API Key。

AsyncDynamic(Arc<AsyncApiKeyProvider>)

每次请求或重试时异步生成 API Key。

Implementations

impl ApiKeySource

pub fn from_static<T>(value: T) -> Self

where T: Into<String>,

创建一个静态 API Key 来源。

pub fn from_provider<F>(provider: F) -> Self

where F: Fn() -> Result<SecretString> + Send + Sync + 'static,

创建一个动态 API Key 来源。

pub fn from_async_provider<F, Fut>(provider: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<SecretString>> + Send + 'static,

创建一个异步 API Key 来源。

pub fn resolve(&self) -> Result<SecretString>

在当前时刻解析出可用的 API Key。

Errors

当动态回调返回错误时返回对应错误。

若来源是异步回调，请改用 Self::resolve_async。

pub async fn resolve_async(&self) -> Result<SecretString>

在当前时刻异步解析出可用的 API Key。

Errors

当动态回调返回错误时返回对应错误。

pub fn redacted(&self) -> String

返回一个可用于日志的脱敏字符串。

Trait Implementations

impl Clone for ApiKeySource

fn clone(&self) -> ApiKeySource

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiKeySource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<SecretBox<str>> for ApiKeySource

fn from(value: SecretString) -> Self

Converts to this type from the input type.

impl TryFrom<Option<ApiKeySource>> for ApiKeySource

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Option<ApiKeySource>) -> Result<Self>

Performs the conversion.