Struct qiniu_http_client::HttpClient

pub struct HttpClient { /* private fields */ }

HTTP 客户端

用于发送 HTTP 请求的入口。

其中 HTTP 请求将由 HttpCaller 实现的实例来发送，如果不指定，默认通过当前启用的功能来判定。

私有云获取当前账户的 Buckets 列表

阻塞代码示例

use qiniu_credential::Credential;
use qiniu_http_client::{Authorization, HttpClient, Region, RegionsProviderEndpoints, ServiceName};

let region = Region::builder("z0")
    .add_uc_preferred_endpoint("uc-qos.pocdemo.qiniu.io".parse()?)
    .build();
let credential = Credential::new("abcdefghklmnopq", "1234567890");
let bucket_names: Vec<String> = HttpClient::default()
    .get(&[ServiceName::Uc], RegionsProviderEndpoints::new(region))
    .use_https(false)
    .authorization(Authorization::v2(credential))
    .accept_json()
    .path("/buckets")
    .call()?
    .parse_json()?
    .into_body();

异步代码示例

use qiniu_credential::Credential;
use qiniu_http_client::{Authorization, HttpClient, Region, RegionsProviderEndpoints, ServiceName};

let region = Region::builder("z0")
    .add_uc_preferred_endpoint("uc-qos.pocdemo.qiniu.io".parse()?)
    .build();
let credential = Credential::new("abcdefghklmnopq", "1234567890");
let bucket_names: Vec<String> = HttpClient::default()
    .async_get(&[ServiceName::Uc], RegionsProviderEndpoints::new(region))
    .use_https(false)
    .authorization(Authorization::v2(credential))
    .accept_json()
    .path("/buckets")
    .call()
    .await?
    .parse_json()
    .await?
    .into_body();

Implementations

impl HttpClient

pub fn ureq() -> Self

Available on crate feature ureq only.

创建一个新的 HTTP 客户端，使用 crate::ureq::Client 作为 HttpCaller 实现

pub fn isahc() -> Result<Self, IsahcError>

Available on crate feature isahc only.

创建一个新的 HTTP 客户端，使用 crate::isahc::Client 作为 HttpCaller 实现

pub fn reqwest_sync() -> Self

Available on crate feature reqwest only.

创建一个新的 HTTP 客户端，使用 crate::reqwest::SyncClient 作为 HttpCaller 实现

pub fn reqwest_async() -> Self

Available on crate features reqwest and async only.

创建一个新的 HTTP 客户端，使用 crate::reqwest::AsyncClient 作为 HttpCaller 实现

pub fn build_default() -> HttpClientBuilder

创建一个新的 HTTP 客户端，根据当前环境变量选择 HttpCaller 实现

Examples found in repository

src/regions/regions_provider/all_regions_provider.rs (line 148)

    pub fn use_https(self, use_https: bool) -> Self {
        self.http_client(HttpClient::build_default().use_https(use_https).build())
    }

src/regions/endpoints_provider/bucket_domains_provider.rs (line 147)

    pub fn use_https(&mut self, use_https: bool) -> &mut Self {
        self.http_client(HttpClient::build_default().use_https(use_https).build())
    }

src/regions/regions_provider/bucket_regions_queryer.rs (line 159)

    pub fn use_https(&mut self, use_https: bool) -> &mut Self {
        self.http_client(HttpClient::build_default().use_https(use_https).build())
    }

pub fn build_ureq() -> HttpClientBuilder

Available on crate feature ureq only.

创建一个新的 HTTP 客户端构建器，使用 crate::ureq::Client 作为 HttpCaller 实现

Examples found in repository

src/client/http_client.rs (line 115)

    pub fn ureq() -> Self {
        Self::build_ureq().build()
    }

pub fn build_isahc() -> Result<HttpClientBuilder, IsahcError>

Available on crate feature isahc only.

创建一个新的 HTTP 客户端构建器，使用 crate::isahc::Client 作为 HttpCaller 实现

Examples found in repository

src/client/http_client.rs (line 123)

    pub fn isahc() -> Result<Self, IsahcError> {
        Ok(Self::build_isahc()?.build())
    }

pub fn build_reqwest_sync() -> HttpClientBuilder

Available on crate feature reqwest only.

创建一个新的 HTTP 客户端构建器，使用 crate::reqwest::SyncClient 作为 HttpCaller 实现

Examples found in repository

src/client/http_client.rs (line 131)

    pub fn reqwest_sync() -> Self {
        Self::build_reqwest_sync().build()
    }

pub fn build_reqwest_async() -> HttpClientBuilder

Available on crate features reqwest and async only.

创建一个新的 HTTP 客户端构建器，使用 crate::reqwest::AsyncClient 作为 HttpCaller 实现

Examples found in repository

src/client/http_client.rs (line 139)

    pub fn reqwest_async() -> Self {
        Self::build_reqwest_async().build()
    }

pub fn new(http_caller: impl HttpCaller + 'static) -> Self

创建一个新的 HTTP 客户端，需要指定 HttpCaller 实现

pub fn builder(http_caller: impl HttpCaller + 'static) -> HttpClientBuilder

创建一个新的 HTTP 客户端构建器，需要指定 HttpCaller 实现

pub fn get<'r, E: EndpointsProvider + 'r>(
    &'r self,
    service_names: &'r [ServiceName],
    endpoints_provider: E
) -> SyncRequestBuilder<'r, E>

创建 GET 请求的请求构建器

该方法的异步版本为 HttpClient::async_get。

Examples found in repository

src/regions/regions_provider/all_regions_provider.rs (line 260)

        fn do_sync_query(&self) -> ApiResult<GotRegions> {
            handle_response_body(
                self.http_client
                    .get(&[ServiceName::Uc], &self.uc_endpoints)
                    .path("/regions")
                    .authorization(Authorization::v2(&self.credential_provider))
                    .accept_json()
                    .call()?
                    .parse_json::<ResponseBody>()?,
            )
        }

src/regions/regions_provider/bucket_regions_queryer.rs (line 290)

    fn do_sync_query(&self) -> ApiResult<GotRegions> {
        handle_response_body(
            self.queryer
                .http_client
                .get(&[ServiceName::Uc, ServiceName::Api], &self.queryer.uc_endpoints)
                .path("/v4/query")
                .append_query_pair("ak", self.access_key.as_str())
                .append_query_pair("bucket", self.bucket_name.as_str())
                .accept_json()
                .call()?
                .parse_json::<ResponseBody>()?,
        )
    }

src/regions/endpoints_provider/bucket_domains_provider.rs (line 276)

    fn do_sync_query(&self) -> ApiResult<Endpoints> {
        let endpoints: Endpoints = self
            .queryer
            .http_client
            .get(&[ServiceName::Uc], &self.queryer.uc_endpoints)
            .path("/v2/domains")
            .authorization(Authorization::v2(&self.credential))
            .append_query_pair("tbl", self.bucket_name.as_str())
            .accept_json()
            .call()?
            .parse_json::<Vec<String>>()?
            .into_body()
            .into_iter()
            .map(Endpoint::from)
            .collect();
        Ok(endpoints)
    }

pub fn post<'r, E: EndpointsProvider + 'r>(
    &'r self,
    service_names: &'r [ServiceName],
    endpoints_provider: E
) -> SyncRequestBuilder<'r, E>

创建 POST 请求的请求构建器

该方法的异步版本为 HttpClient::async_post。

pub fn put<'r, E: EndpointsProvider + 'r>(
    &'r self,
    service_names: &'r [ServiceName],
    endpoints_provider: E
) -> SyncRequestBuilder<'r, E>

创建 PUT 请求的请求构建器

该方法的异步版本为 HttpClient::async_put。

pub fn delete<'r, E: EndpointsProvider + 'r>(
    &'r self,
    service_names: &'r [ServiceName],
    endpoints_provider: E
) -> SyncRequestBuilder<'r, E>

创建 DELETE 请求的请求构建器

该方法的异步版本为 HttpClient::async_delete。

pub fn new_request<'r, E: EndpointsProvider + 'r>(
    &'r self,
    method: Method,
    service_names: &'r [ServiceName],
    endpoints_provider: E
) -> SyncRequestBuilder<'r, E>

创建请求的请求构建器

该方法的异步版本为 HttpClient::new_async_request。

Examples found in repository

src/client/http_client.rs (line 201)

    pub fn get<'r, E: EndpointsProvider + 'r>(
        &'r self,
        service_names: &'r [ServiceName],
        endpoints_provider: E,
    ) -> SyncRequestBuilder<'r, E> {
        self.new_request(Method::GET, service_names, endpoints_provider)
    }

    /// 创建 POST 请求的请求构建器
    ///
    /// 该方法的异步版本为 [`HttpClient::async_post`]。
    #[inline]
    pub fn post<'r, E: EndpointsProvider + 'r>(
        &'r self,
        service_names: &'r [ServiceName],
        endpoints_provider: E,
    ) -> SyncRequestBuilder<'r, E> {
        self.new_request(Method::POST, service_names, endpoints_provider)
    }

    /// 创建 PUT 请求的请求构建器
    ///
    /// 该方法的异步版本为 [`HttpClient::async_put`]。
    #[inline]
    pub fn put<'r, E: EndpointsProvider + 'r>(
        &'r self,
        service_names: &'r [ServiceName],
        endpoints_provider: E,
    ) -> SyncRequestBuilder<'r, E> {
        self.new_request(Method::PUT, service_names, endpoints_provider)
    }

    /// 创建 DELETE 请求的请求构建器
    ///
    /// 该方法的异步版本为 [`HttpClient::async_delete`]。
    #[inline]
    pub fn delete<'r, E: EndpointsProvider + 'r>(
        &'r self,
        service_names: &'r [ServiceName],
        endpoints_provider: E,
    ) -> SyncRequestBuilder<'r, E> {
        self.new_request(Method::DELETE, service_names, endpoints_provider)
    }

pub fn async_get<'r, E: EndpointsProvider + 'r>(
    &'r self,
    service_names: &'r [ServiceName],
    endpoints_provider: E
) -> AsyncRequestBuilder<'r, E>

Available on crate feature async only.

创建 GET 请求的异步请求构建器

Examples found in repository

src/regions/regions_provider/all_regions_provider.rs (line 273)

        async fn do_async_query(&self) -> ApiResult<GotRegions> {
            handle_response_body(
                self.http_client
                    .async_get(&[ServiceName::Uc], &self.uc_endpoints)
                    .path("/regions")
                    .authorization(Authorization::v2(&self.credential_provider))
                    .accept_json()
                    .call()
                    .await?
                    .parse_json::<ResponseBody>()
                    .await?,
            )
        }

src/regions/regions_provider/bucket_regions_queryer.rs (line 305)

    async fn do_async_query(&self) -> ApiResult<GotRegions> {
        handle_response_body(
            self.queryer
                .http_client
                .async_get(&[ServiceName::Uc, ServiceName::Api], &self.queryer.uc_endpoints)
                .path("/v4/query")
                .append_query_pair("ak", self.access_key.as_str())
                .append_query_pair("bucket", self.bucket_name.as_str())
                .accept_json()
                .call()
                .await?
                .parse_json::<ResponseBody>()
                .await?,
        )
    }

src/regions/endpoints_provider/bucket_domains_provider.rs (line 295)

    async fn do_async_query(&self) -> ApiResult<Endpoints> {
        let endpoints: Endpoints = self
            .queryer
            .http_client
            .async_get(&[ServiceName::Uc], &self.queryer.uc_endpoints)
            .path("/v2/domains")
            .authorization(Authorization::v2(&self.credential))
            .append_query_pair("tbl", self.bucket_name.as_str())
            .accept_json()
            .call()
            .await?
            .parse_json::<Vec<String>>()
            .await?
            .into_body()
            .into_iter()
            .map(Endpoint::from)
            .collect();
        Ok(endpoints)
    }

pub fn async_post<'r, E: EndpointsProvider + 'r>(
    &'r self,
    service_names: &'r [ServiceName],
    endpoints_provider: E
) -> AsyncRequestBuilder<'r, E>

Available on crate feature async only.

创建 POST 请求的异步请求构建器

pub fn async_put<'r, E: EndpointsProvider + 'r>(
    &'r self,
    service_names: &'r [ServiceName],
    endpoints_provider: E
) -> AsyncRequestBuilder<'r, E>

Available on crate feature async only.

创建 PUT 请求的异步请求构建器

pub fn async_delete<'r, E: EndpointsProvider + 'r>(
    &'r self,
    service_names: &'r [ServiceName],
    endpoints_provider: E
) -> AsyncRequestBuilder<'r, E>

Available on crate feature async only.

创建 DELETE 请求的异步请求构建器

pub fn new_async_request<'r, E: EndpointsProvider + 'r>(
    &'r self,
    method: Method,
    service_names: &'r [ServiceName],
    endpoints_provider: E
) -> AsyncRequestBuilder<'r, E>

创建异步请求的请求构建器

Examples found in repository

src/client/http_client.rs (line 262)

    pub fn async_get<'r, E: EndpointsProvider + 'r>(
        &'r self,
        service_names: &'r [ServiceName],
        endpoints_provider: E,
    ) -> AsyncRequestBuilder<'r, E> {
        self.new_async_request(Method::GET, service_names, endpoints_provider)
    }

    /// 创建 POST 请求的异步请求构建器
    #[inline]
    #[cfg(feature = "async")]
    #[cfg_attr(feature = "docs", doc(cfg(feature = "async")))]
    pub fn async_post<'r, E: EndpointsProvider + 'r>(
        &'r self,
        service_names: &'r [ServiceName],
        endpoints_provider: E,
    ) -> AsyncRequestBuilder<'r, E> {
        self.new_async_request(Method::POST, service_names, endpoints_provider)
    }

    /// 创建 PUT 请求的异步请求构建器
    #[inline]
    #[cfg(feature = "async")]
    #[cfg_attr(feature = "docs", doc(cfg(feature = "async")))]
    pub fn async_put<'r, E: EndpointsProvider + 'r>(
        &'r self,
        service_names: &'r [ServiceName],
        endpoints_provider: E,
    ) -> AsyncRequestBuilder<'r, E> {
        self.new_async_request(Method::PUT, service_names, endpoints_provider)
    }

    /// 创建 DELETE 请求的异步请求构建器
    #[inline]
    #[cfg(feature = "async")]
    #[cfg_attr(feature = "docs", doc(cfg(feature = "async")))]
    pub fn async_delete<'r, E: EndpointsProvider + 'r>(
        &'r self,
        service_names: &'r [ServiceName],
        endpoints_provider: E,
    ) -> AsyncRequestBuilder<'r, E> {
        self.new_async_request(Method::DELETE, service_names, endpoints_provider)
    }

impl HttpClient

pub fn default_http_caller() -> Box<dyn HttpCaller>

获得默认的 HttpCaller 实例

默认通过当前启用的功能来判定

pub fn default_resolver() -> Box<dyn Resolver>

获得默认的 Resolver 实例

默认通过当前启用的功能来判定，并使用 CachedResolver 和 ShuffledResolver 对其进行包装。

pub fn default_chooser() -> Box<dyn Chooser>

获得默认的 Chooser 实例

默认使用 SubnetChooser，并使用 ShuffledChooser 和 NeverEmptyHandedChooser 对其进行包装。

pub fn default_retrier() -> Box<dyn RequestRetrier>

获得默认的 RequestRetrier 实例

默认使用 ErrorRetrier，并使用 LimitedRetrier 对其进行包装。

pub fn default_backoff() -> Box<dyn Backoff>

获得默认的 Backoff 实例

默认使用 ExponentialBackoff，并使用 LimitedBackoff 和 RandomizedBackoff 对其进行包装。

Trait Implementations

impl Clone for HttpClient

fn clone(&self) -> HttpClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpClient

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

Formats the value using the given formatter.

impl Default for HttpClient

fn default() -> Self

Returns the “default value” for a type.