LibOss.Model.Config (lib_oss v0.3.0)

View Source

配置模型，提供配置验证和管理功能。

该模块是对新配置系统的兼容性封装，保持原有API的同时 使用增强的配置验证器。

迁移说明

此模块保持向后兼容，但建议新代码直接使用：

示例

iex> config = [
...>   access_key_id: "test_access_key_id_123",
...>   access_key_secret: "test_access_key_secret_12345678901234567890",
...>   endpoint: "oss-cn-hangzhou.aliyuncs.com"
...> ]
iex> {:ok, result} = LibOss.Model.Config.validate(config)
iex> Keyword.get(result, :access_key_id)
"test_access_key_id_123"

Summary

Types

t()

Functions

get_schema()

获取配置模式定义（兼容性函数）。

validate(config)

验证配置参数。

validate!(config)

验证配置参数，验证失败时抛出异常。

validate_enhanced(config, opts \\ [])

验证配置参数（增强版本）。

validate_enhanced!(config, opts \\ [])

验证配置参数（增强版本），验证失败时抛出异常。

Types

t()

@type t() :: keyword()

Functions

get_schema()

@spec get_schema() :: keyword()

获取配置模式定义（兼容性函数）。

返回值

  • NimbleOptions 模式定义

validate(config)

@spec validate(keyword()) :: {:ok, keyword()} | {:error, String.t()}

验证配置参数。

参数

  • config - 配置关键字列表

返回值

  • {:ok, validated_config} - 验证成功
  • {:error, error_message} - 验证失败

示例

iex> config = [
...>   access_key_id: "test_access_key_id_123",
...>   access_key_secret: "test_access_key_secret_12345678901234567890",
...>   endpoint: "oss-cn-hangzhou.aliyuncs.com"
...> ]
iex> {:ok, result} = LibOss.Model.Config.validate(config)
iex> Keyword.get(result, :access_key_id)
"test_access_key_id_123"

validate!(config)

@spec validate!(keyword()) :: keyword()

验证配置参数，验证失败时抛出异常。

参数

  • config - 配置关键字列表

返回值

  • validated_config - 验证成功的配置

异常

示例

iex> config = [
...>   access_key_id: "test_access_key_id_123",
...>   access_key_secret: "test_access_key_secret_12345678901234567890",
...>   endpoint: "oss-cn-hangzhou.aliyuncs.com"
...> ]
iex> result = LibOss.Model.Config.validate!(config)
iex> Keyword.get(result, :access_key_id)
"test_access_key_id_123"

validate_enhanced(config, opts \\ [])

@spec validate_enhanced(keyword(), keyword()) ::
  {:ok, keyword()} | {:error, String.t()}

验证配置参数（增强版本）。

参数

  • config - 配置关键字列表
  • opts - 验证选项

返回值

  • {:ok, validated_config} - 验证成功
  • {:error, error_message} - 验证失败

validate_enhanced!(config, opts \\ [])

@spec validate_enhanced!(keyword(), keyword()) :: keyword()

验证配置参数（增强版本），验证失败时抛出异常。

参数

  • config - 配置关键字列表
  • opts - 验证选项

返回值

  • validated_config - 验证成功的配置

异常