Struct aliyun_oss_client::client::Client

#[non_exhaustive]
pub struct Client<M = ClientWithMiddleware> { /* private fields */ }

构造请求的客户端结构体

Implementations

impl Client

pub async fn get_bucket_list(self) -> Result<ListBuckets, ExtractListError>

从 OSS 获取 bucket 列表

pub async fn base_bucket_list<List, Item, E, ItemErr>( &self, list: &mut List ) -> Result<(), ExtractListError>

where List: RefineBucketList<Item, E, ItemErr> + InitObject<Item>, Item: RefineBucket<ItemErr>, E: ListError, ItemErr: Error + 'static,

从 OSS 获取 bucket 列表，并存入自定义类型中

pub async fn get_bucket_info(self) -> Result<Bucket, ExtractItemError>

从 OSS 上获取默认的 bucket 信息

pub async fn base_bucket_info<Bucket, E>( &self, bucket: &mut Bucket ) -> Result<(), ExtractItemError>

where Bucket: RefineBucket<E>, E: Error + 'static,

从 OSS 上获取 bucket 的信息，并存入自定义的类型中

默认获取 Client 中的默认 bucket 信息，如需获取其他 bucket，可调用 set_bucket 更改后调用

也可以调用 set_endpoint 更改可用区

impl Client<ClientWithMiddleware>

pub fn get_bucket_list(self) -> Result<ListBuckets<RcPointer>, ExtractListError>

获取 bucket 列表

pub fn base_bucket_list<List, Item, E, ItemErr>( &self, list: &mut List ) -> Result<(), ExtractListError>

where List: RefineBucketList<Item, E, ItemErr> + InitObject<Item>, Item: RefineBucket<ItemErr>, E: ListError, ItemErr: Error + 'static,

获取 bucket 列表，可存储为自定义的类型

pub fn get_bucket_info(self) -> Result<Bucket<RcPointer>, ExtractItemError>

获取当前的 bucket 的信息

pub fn base_bucket_info<Bucket, E>( &self, bucket: &mut Bucket ) -> Result<(), ExtractItemError>

where Bucket: RefineBucket<E>, E: Error + 'static,

获取某一个 bucket 的信息，并存储到自定义的类型

impl<M: Default> Client<M>

pub fn new( access_key_id: KeyId, access_key_secret: KeySecret, endpoint: EndPoint, bucket: BucketName ) -> Self

使用基本配置信息初始化 Client

pub fn from_config(config: Config) -> Self

使用 Config 中的配置初始化 Client

pub fn from_env() -> Result<Self, InvalidConfig>

通过环境变量初始化 Client

如果在 Aliyun ECS 上，可将环境变量 ALIYUN_OSS_INTERNAL 设置为 true / 1 / yes / Y ，即可使用 internal 网络请求 OSS 接口

示例

use std::env::set_var;
set_var("ALIYUN_KEY_ID", "foo1");
set_var("ALIYUN_KEY_SECRET", "foo2");
set_var("ALIYUN_ENDPOINT", "qingdao");
set_var("ALIYUN_BUCKET", "foo4");

use aliyun_oss_client::builder::ClientWithMiddleware;
let client = Client::<ClientWithMiddleware>::from_env();
assert!(client.is_ok());

impl<M> Client<M>

pub fn get_bucket_base(&self) -> BucketBase

返回默认可用区，默认 bucket 的 BucketBase

pub fn get_bucket_url(&self) -> Url

获取默认的 bucket 的 url

pub fn get_endpoint_url(&self) -> Url

获取默认的可用区的 url

pub fn set_bucket(&mut self, bucket: BucketName)

更改默认 bucket

pub fn set_endpoint(&mut self, endpoint: EndPoint)

更改默认 endpoint

pub fn timeout(&mut self, timeout: Duration)

设置 timeout

pub fn get_object_base<P>( &self, path: P ) -> Result<ObjectBase, InvalidObjectPath>

where P: TryInto<ObjectPath>, P::Error: Into<InvalidObjectPath>,

根据默认的 bucket，endpoint 和提供的文件路径，获取 ObjectBase

impl Client

pub async fn get_object_list<Q: IntoIterator<Item = (QueryKey, QueryValue)>>( &self, query: Q ) -> Result<ObjectList, ExtractListError>

查询默认 bucket 的文件列表

查询条件参数有多种方式，具体参考 get_object_list 文档

pub async fn get_object_list2( &self, query: Query ) -> Result<ObjectList, ExtractListError>

查询默认 bucket 的文件列表

pub async fn base_object_list<Q: IntoIterator<Item = (QueryKey, QueryValue)>, List, Item, E: ListError, ItemErr: Error + 'static>( &self, query: Q, list: &mut List ) -> Result<(), ExtractListError>

where List: RefineObjectList<Item, E, ItemErr> + InitObject<Item>, Item: RefineObject<ItemErr>,

可将 object 列表导出到外部类型（关注便捷性）

从 Client 中的默认 bucket 中获取，如需获取其他 bucket 的，可调用 set_bucket 更改后调用

也可以通过调用 set_endpoint 更改可用区

可以参考下面示例，或者项目中的 examples/custom.rs

示例

use aliyun_oss_client::{
    decode::{ListError, RefineObject, RefineObjectList},
    object::{ExtractListError, InitObject},
    Client,
};
use dotenv::dotenv;
use thiserror::Error;

#[derive(Debug)]
struct MyFile {
    key: String,
    #[allow(dead_code)]
    other: String,
}
impl RefineObject<MyError> for MyFile {
    fn set_key(&mut self, key: &str) -> Result<(), MyError> {
        self.key = key.to_string();
        Ok(())
    }
}

#[derive(Default, Debug)]
struct MyBucket {
    name: String,
    files: Vec<MyFile>,
}

impl RefineObjectList<MyFile, MyError> for MyBucket {
    fn set_name(&mut self, name: &str) -> Result<(), MyError> {
        self.name = name.to_string();
        Ok(())
    }
    fn set_list(&mut self, list: Vec<MyFile>) -> Result<(), MyError> {
        self.files = list;
        Ok(())
    }
}

#[derive(Debug, Error)]
#[error("my error")]
enum MyError {}

impl ListError for MyError {}

async fn run() -> Result<(), ExtractListError> {
    dotenv().ok();
    use aliyun_oss_client::BucketName;

    let client = Client::from_env().unwrap();

    // 除了设置Default 外，还可以做更多设置
    let mut bucket = MyBucket {
        name: "abc".to_string(),
        files: Vec::with_capacity(20),
    };

    // 利用闭包对 MyFile 做一下初始化设置
    impl InitObject<MyFile> for MyBucket {
        fn init_object(&mut self) -> Option<MyFile> {
            Some(MyFile {
              key: String::default(),
              other: "abc".to_string(),
            })
        }
    }

    client.base_object_list([], &mut bucket).await?;

    println!("bucket: {:?}", bucket);

    Ok(())
}

pub async fn base_object_list2<List, Item, E: ListError, ItemErr: Error + 'static>( &self, query: &Query, list: &mut List ) -> Result<(), ExtractListError>

where List: RefineObjectList<Item, E, ItemErr> + InitObject<Item>, Item: RefineObject<ItemErr>,

可将 object 列表导出到外部类型（关注性能）

从 Client 中的默认 bucket 中获取，如需获取其他 bucket 的，可调用 set_bucket 更改后调用

也可以通过调用 set_endpoint 更改可用区

pub async fn get_custom_object<Item, ItemErr>( &self, query: &Query ) -> Result<Objects<Item>, ExtractListError>

where Item: RefineObject<ItemErr>, Objects<Item>: InitObject<Item>, ItemErr: Error + 'static,

获取包含自定义类型的 object 集合

其包含在 ObjectList 对象中

impl Client<ClientWithMiddleware>

pub fn get_object_list<Q: IntoIterator<Item = (QueryKey, QueryValue)>>( self, query: Q ) -> Result<ObjectList<RcPointer>, ExtractListError>

查询默认 bucket 的文件列表

查询条件参数有多种方式，具体参考 get_object_list 文档

pub fn base_object_list<Q: IntoIterator<Item = (QueryKey, QueryValue)>, List, Item, F, E: ListError, ItemErr: Error + 'static>( &self, query: Q, list: &mut List, init_object: F ) -> Result<(), ExtractListError>

where List: RefineObjectList<Item, E, ItemErr>, Item: RefineObject<ItemErr>, F: Fn(&mut List) -> Option<Item>,

可将 object 列表导出到外部 struct

Trait Implementations

impl AlignBuilder for Client<ClientWithMiddleware>

fn builder_with_header<H: IntoIterator<Item = (HeaderName, HeaderValue)>>( &self, method: Method, url: Url, resource: CanonicalizedResource, headers: H ) -> Result<RequestBuilder, BuilderError>

构造自定义的接口请求方法

比如在上传完文件时，返回自己期望的数据，而不是仅返回 etag 信息

例子是一个获取 object 元信息的接口

use aliyun_oss_client::{errors::OssError, file::AlignBuilder, Client, Method};
use dotenv::dotenv;

async fn run() -> Result<(), OssError> {
    dotenv().ok();
    let client = Client::from_env().unwrap();

    let (url, resource) = client
        .get_object_base("9AB932LY.jpeg")?
        .get_url_resource([]);

    let headers = vec![(
        "If-Unmodified-Since".parse().unwrap(),
        "Sat, 01 Jan 2022 18:01:01 GMT".parse().unwrap(),
    )];

    let builder = client.builder_with_header(Method::HEAD, url, resource, headers)?;

    let response = builder.send().await?;

    println!("status: {:?}", response.status());

    Ok(())
}

参数

• method 接口请求方式
• url 要请求的接口，包含 query 参数等信息
• resource 阿里云接口需要提供的统一的信息，CanonicalizedResource 提供了 bucket ，object 等各种生成方式，如果无法满足 还可以自己用 trait 来自定义

返回值

返回值是一个封装了 reqwest::Builder 构造器，RequestBuilder, 提供两个方法 send 和 send_adjust_error

• send 方法，直接返回 reqwest::Response
• send_adjust_error 方法，会对 api 返回结果进行处理，如果 HTTP 状态码正常（200>= && <300) 则，返回 Ok, 否则，会对返回的 xml 异常数据进行解析，返回 Err(OssService)

fn builder( &self, method: Method, url: Url, resource: CanonicalizedResource ) -> Result<RequestBuilder, BuilderError>

根据具体的 API 接口参数，返回请求的构建器（不带 headers）

impl AlignBuilder for Client<ClientWithMiddleware>

fn builder_with_header<H: IntoIterator<Item = (HeaderName, HeaderValue)>>( &self, method: Method, url: Url, resource: CanonicalizedResource, headers: H ) -> Result<BlockingRequestBuilder, BuilderError>

向 OSS 发送请求的封装

参数包含请求的：

• method
• url
• headers (可选)
• CanonicalizedResource

返回值是一个 reqwest 的请求创建器 reqwest::blocking::RequestBuilder

返回后，可以再加请求参数，然后可选的进行发起请求

fn builder( &self, method: Method, url: Url, resource: CanonicalizedResource ) -> Result<RequestBuilder, BuilderError>

根据具体的 API 接口参数，返回请求的构建器（不带 headers）

impl<M> AsMut<BucketName> for Client<M>

fn as_mut(&mut self) -> &mut BucketName

Converts this type into a mutable reference of the (usually inferred) input type.

impl<M> AsMut<Option<Duration>> for Client<M>

fn as_mut(&mut self) -> &mut Option<Duration>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<M> AsRef<BucketName> for Client<M>

fn as_ref(&self) -> &BucketName

Converts this type into a shared reference of the (usually inferred) input type.

impl<M> AsRef<EndPoint> for Client<M>

fn as_ref(&self) -> &EndPoint

Converts this type into a shared reference of the (usually inferred) input type.

impl<M: Clone> Clone for Client<M>

fn clone(&self) -> Client<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for Client<M>

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

Formats the value using the given formatter.

impl<M: Default> Default for Client<M>

fn default() -> Client<M>

Returns the “default value” for a type.

impl<'a, M: Default + Clone> From<&'a Client<M>> for QueryAuth<'a>

fn from(client: &'a Client<M>) -> Self

Converts to this type from the input type.

impl From<Client<ClientWithMiddleware>> for Content

fn from(value: Client) -> Self

Converts to this type from the input type.

impl<M> From<Client<M>> for BucketBase

fn from(_: Client<M>) -> Self

Converts to this type from the input type.

impl From<Client> for Content

fn from(value: Client) -> Self

Converts to this type from the input type.

impl<M: PartialEq> PartialEq for Client<M>

fn eq(&self, other: &Client<M>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M: Default> STS for Client<M>

fn new_with_sts<ST>( access_key_id: KeyId, access_key_secret: KeySecret, endpoint: EndPoint, bucket: BucketName, security_token: ST ) -> Result<Self, InvalidHeaderValue>

where ST: TryInto<HeaderValue>, ST::Error: Into<InvalidHeaderValue>,

用 STS 配置信息初始化 Client

impl<M: Eq> Eq for Client<M>

impl<M> StructuralPartialEq for Client<M>