Struct ClientConfig 

pub struct ClientConfig {
    pub region: Region,
    pub endpoint: Endpoint,
    pub timeout: Duration,
    pub retry: Option<RetryConfig>,
    pub proxy: Option<String>,
    pub is_https: bool,
}

客户端配置

示例

use tencentcloud_sms::{ClientConfig, Region, Endpoint};

// 默认配置（广州地域，就近接入）
let config = ClientConfig::default();

// 指定地域
let config = ClientConfig::builder()
    .region(Region::ApBeijing)
    .build();

// 金融地域（需使用 Region 接入点）
let config = ClientConfig::builder()
    .region(Region::ApShanghaiFsi)
    .endpoint(Endpoint::Region)
    .build();

// 国际短信
let config = ClientConfig::builder()
    .endpoint(Endpoint::International)
    .build();

Fields

region: Region

服务地域

指定 API 的服务地域，用于 X-TC-Region 请求头。 默认为广州 (ApGuangzhou)。

endpoint: Endpoint

接入点配置

• Nearest: 就近接入（默认）
• Region(region): 指定地域接入点
• International: 国际短信接入点
• Custom(host): 自定义域名

timeout: Duration

请求超时时间

retry: Option<RetryConfig>

重试配置

proxy: Option<String>

代理服务器地址

is_https: bool

是否使用 HTTPS

Implementations

impl ClientConfig

pub fn builder() -> ClientConfigBuilder<((), (), (), (), (), ())>

Create a builder for building ClientConfig. On the builder, call .region(...)(optional), .endpoint(...)(optional), .timeout(...)(optional), .retry(...)(optional), .proxy(...)(optional), .is_https(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ClientConfig.

impl ClientConfig

pub fn new() -> Self

创建默认配置

pub fn validate(&self) -> SmsResult<()>

验证配置是否合法

错误

• 超时时间为 0
• 金融地域未使用 Region 接入点
• 重试配置参数无效

pub fn with_region(region: Region) -> Self

使用指定地域创建配置

示例

use tencentcloud_sms::{ClientConfig, Region};

let config = ClientConfig::with_region(Region::ApBeijing);

pub fn financial_shanghai() -> Self

使用上海金融地域创建配置

自动设置 Region 为上海金融区，Endpoint 为 Region 接入点。

示例

use tencentcloud_sms::ClientConfig;

let config = ClientConfig::financial_shanghai();

pub fn financial_shenzhen() -> Self

使用深圳金融地域创建配置

自动设置 Region 为深圳金融区，Endpoint 为 Region 接入点。

示例

use tencentcloud_sms::ClientConfig;

let config = ClientConfig::financial_shenzhen();

pub fn international() -> Self

使用国际短信接入点创建配置

示例

use tencentcloud_sms::ClientConfig;

let config = ClientConfig::international();

pub fn with_timeout(timeout: Duration) -> Self

自定义超时时间

示例

use std::time::Duration;
use tencentcloud_sms::ClientConfig;

let config = ClientConfig::with_timeout(Duration::from_secs(60));

pub fn without_retry() -> Self

禁用重试

示例

use tencentcloud_sms::ClientConfig;

let config = ClientConfig::without_retry();

pub fn with_retry(retry: RetryConfig) -> Self

自定义重试配置

示例

use tencentcloud_sms::{ClientConfig, RetryConfig};

let retry_config = RetryConfig::builder()
    .max_retries(5)
    .build();
let config = ClientConfig::with_retry(retry_config);

pub fn host(&self) -> &str

获取实际使用的域名

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.