Struct Client 

pub struct Client { /* private fields */ }

An synchronous OSS client which requesting aliyun OSS api in blocking mode.

Implementations

impl Client

pub fn presign_url<S1, S2>( &self, bucket_name: S1, object_key: S2, options: PresignGetOptions, ) -> String

where S1: AsRef<str>, S2: AsRef<str>,

Presign URL for GET request without any additional headers supported, for brower mostly

pub fn presign_raw_request(&self, oss_request: OssRequest) -> SignedOssRequest

impl Client

pub fn from_env() -> Self

Creates a new client from environment variables.

• ALI_ACCESS_KEY_ID The access key id
• ALI_ACCESS_KEY_SECRET The access key secret
• ALI_OSS_ENDPOINT The endpoint of the OSS service. e.g. oss-cn-hangzhou.aliyuncs.com. Or, you can write full URL http://oss-cn-hangzhou.aliyuncs.com or https://oss-cn-hangzhou.aliyuncs.com with scheme http or https.
• ALI_OSS_REGION Optional. The region of the OSS service. If not present, It will be inferred from the ALI_OSS_ENDPOINT env.

pub fn new<S1, S2, S3, S4>( access_key_id: S1, access_key_secret: S2, region: S3, endpoint: S4, ) -> Self

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>, S4: AsRef<str>,

pub fn clone_to<S1, S2>(&self, region: S1, endpoint: S2) -> Self

where S1: AsRef<str>, S2: AsRef<str>,

Clone a new client instance with the same security data and different region. This is helpful if you are operation on buckets across multiple regions with a single pair of access key id and secret.

Trait Implementations

impl BucketOperations for Client

fn put_bucket<S: AsRef<str>>( &self, bucket_name: S, config: PutBucketConfiguration, options: Option<PutBucketOptions>, ) -> Result<()>

fn list_buckets( &self, options: Option<ListBucketsOptions>, ) -> Result<ListBucketsResult>

fn get_bucket_info<S: AsRef<str>>(&self, bucket_name: S) -> Result<BucketDetail>

fn get_bucket_location<S: AsRef<str>>(&self, bucket_name: S) -> Result<String>

fn get_bucket_stat<S: AsRef<str>>(&self, bucket_name: S) -> Result<BucketStat>

fn list_objects<S: AsRef<str>>( &self, bucket_name: S, options: Option<ListObjectsOptions>, ) -> Result<ListObjectsResult>

fn delete_bucket<S: AsRef<str>>(&self, bucket_name: S) -> Result<()>

impl CnameOperations for Client

fn list_cname<S>(&self, bucket_name: S) -> Result<Vec<CnameInfo>>

where S: AsRef<str>,

Official document: https://help.aliyun.com/zh/oss/developer-reference/listcname

impl MultipartUploadsOperations for Client

fn list_multipart_uploads<S>( &self, bucket_name: S, options: Option<ListMultipartUploadsOptions>, ) -> Result<ListMultipartUploadsResult>

where S: AsRef<str>,

List multipart uploads which are initialized but not completed nor aborted.

Official document: https://help.aliyun.com/zh/oss/developer-reference/listmultipartuploads

fn list_parts<S1, S2, S3>( &self, bucket_name: S1, object_key: S2, upload_id: S3, options: Option<ListPartsOptions>, ) -> Result<ListPartsResult>

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>,

List parts which uploaded successfully associated with the given upload_id

Official document: https://help.aliyun.com/zh/oss/developer-reference/listparts

fn initiate_multipart_uploads<S1, S2>( &self, bucket_name: S1, object_key: S2, options: Option<InitiateMultipartUploadOptions>, ) -> Result<InitiateMultipartUploadResult>

where S1: AsRef<str>, S2: AsRef<str>,

Initiate multipart uploads

Official document: https://help.aliyun.com/zh/oss/developer-reference/initiatemultipartupload

fn upload_part_from_file<S1, S2, P>( &self, bucket_name: S1, object_key: S2, file_path: P, range: Range<u64>, params: UploadPartRequest, ) -> Result<UploadPartResult>

where S1: AsRef<str>, S2: AsRef<str>, P: AsRef<Path>,

Upload part of a file. the caller should take responsibility to make sure the range is valid.

Official document: https://help.aliyun.com/zh/oss/developer-reference/uploadpart

fn upload_part_from_buffer<S1, S2, B>( &self, bucket_name: S1, object_key: S2, buffer: B, params: UploadPartRequest, ) -> Result<UploadPartResult>

where S1: AsRef<str>, S2: AsRef<str>, B: Into<Vec<u8>>,

Upload part from buffer.

Official document: https://help.aliyun.com/zh/oss/developer-reference/uploadpart

fn upload_part_from_base64<S1, S2, S3>( &self, bucket_name: S1, object_key: S2, base64_string: S3, params: UploadPartRequest, ) -> Result<UploadPartResult>

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>,

Upload part from base64 string.

Official document: https://help.aliyun.com/zh/oss/developer-reference/uploadpart

fn upload_part_copy<S1, S2>( &self, bucket_name: S1, dest_object_key: S2, data: UploadPartCopyRequest, options: Option<UploadPartCopyOptions>, ) -> Result<UploadPartCopyResult>

where S1: AsRef<str>, S2: AsRef<str>,

When you want to copy a file larger than 1GB, you must use upload_part_copy. First, initiate a multipart upload and get uploadId, then call this method to upload parts of the source object. Finally complete the multipart upload by invoking complete_multipart_uploads

Offical document: https://help.aliyun.com/zh/oss/developer-reference/uploadpartcopy

fn complete_multipart_uploads<S1, S2>( &self, bucket_name: S1, object_key: S2, data: CompleteMultipartUploadRequest, options: Option<CompleteMultipartUploadOptions>, ) -> Result<CompleteMultipartUploadResult>

where S1: AsRef<str>, S2: AsRef<str>,

Complete multipart uploads

Official document: https://help.aliyun.com/zh/oss/developer-reference/completemultipartupload

fn abort_multipart_uploads<S1, S2, S3>( &self, bucket_name: S1, object_key: S2, upload_id: S3, ) -> Result<()>

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>,

About multipart uploads

Official document: https://help.aliyun.com/zh/oss/developer-reference/abortmultipartupload

impl ObjectAclOperations for Client

fn get_object_acl<S1, S2>( &self, bucket_name: S1, object_key: S2, options: Option<GetObjectAclOptions>, ) -> Result<ObjectAcl>

where S1: AsRef<str>, S2: AsRef<str>,

Get an object’s acl.

Official document: https://help.aliyun.com/zh/oss/developer-reference/getobjectacl

fn put_object_acl<S1, S2>( &self, bucket_name: S1, object_key: S2, acl: ObjectAcl, options: Option<GetObjectAclOptions>, ) -> Result<()>

where S1: AsRef<str>, S2: AsRef<str>,

Put an object’s acl. If you want to restore the object’s acl to follow bucket acl settings, pass acl as ObjectAcl::Default

Official document: https://help.aliyun.com/zh/oss/developer-reference/putobjectacl

impl ObjectOperations for Client

fn put_object_from_file<S1, S2, P>( &self, bucket_name: S1, object_key: S2, file_path: P, options: Option<PutObjectOptions>, ) -> Result<PutObjectResult>

where S1: AsRef<str>, S2: AsRef<str>, P: AsRef<Path>,

Uploads a file to a specified bucket and object key.

Official document: https://help.aliyun.com/zh/oss/developer-reference/putobject

fn put_object_from_buffer<S1, S2, B>( &self, bucket_name: S1, object_key: S2, buffer: B, options: Option<PutObjectOptions>, ) -> Result<PutObjectResult>

where S1: AsRef<str>, S2: AsRef<str>, B: Into<Vec<u8>>,

Create an object from buffer. If you are going to upload a large file, it is recommended to use upload_file instead. And, it is recommended to set mime_type in options

Official document: https://help.aliyun.com/zh/oss/developer-reference/putobject

fn put_object_from_base64<S1, S2, S3>( &self, bucket_name: S1, object_key: S2, base64_string: S3, options: Option<PutObjectOptions>, ) -> Result<PutObjectResult>

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>,

Create an object from base64 string. And, it is recommended to set mime_type in options

Official document: https://help.aliyun.com/zh/oss/developer-reference/putobject

fn append_object_from_file<S1, S2, P>( &self, bucket_name: S1, object_key: S2, file_path: P, position: u64, options: Option<AppendObjectOptions>, ) -> Result<AppendObjectResult>

where S1: AsRef<str>, S2: AsRef<str>, P: AsRef<Path>,

Append object.

Official document: https://help.aliyun.com/zh/oss/developer-reference/appendobject

fn append_object_from_buffer<S1, S2, B>( &self, bucket_name: S1, object_key: S2, buffer: B, position: u64, options: Option<AppendObjectOptions>, ) -> Result<AppendObjectResult>

where S1: AsRef<str>, S2: AsRef<str>, B: Into<Vec<u8>>,

Append object from buffer. suitable for small size content And, it is recommended to set mime_type in options

Official document: https://help.aliyun.com/zh/oss/developer-reference/putobject

fn append_object_from_base64<S1, S2, S3>( &self, bucket_name: S1, object_key: S2, base64_string: S3, position: u64, options: Option<AppendObjectOptions>, ) -> Result<AppendObjectResult>

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>,

Append object from base64 string. suitable for small size content And, it is recommended to set mime_type in options

Official document: https://help.aliyun.com/zh/oss/developer-reference/putobject

fn get_object_to_file<S1, S2, P>( &self, bucket_name: S1, object_key: S2, file_path: P, options: Option<GetObjectOptions>, ) -> Result<GetObjectResult>

where S1: AsRef<str>, S2: AsRef<str>, P: AsRef<Path>,

Uploads a file to a specified bucket and object key.

Official document: https://help.aliyun.com/zh/oss/developer-reference/getobject

fn get_object_to_buffer<S1, S2>( &self, bucket_name: S1, object_key: S2, options: Option<GetObjectOptions>, ) -> Result<Vec<u8>>

where S1: AsRef<str> + Send, S2: AsRef<str> + Send,

Get object content into memory (bytes array).

Large files can consume significant memory, exercise caution when using this function.

fn create_folder<S1, S2>(&self, bucket_name: S1, object_key: S2) -> Result<()>

where S1: AsRef<str>, S2: AsRef<str>,

Create a “folder”

Official document: https://help.aliyun.com/zh/oss/developer-reference/putobject

fn delete_folder<S1, S2>(&self, bucket_name: S1, object_key: S2) -> Result<()>

where S1: AsRef<str>, S2: AsRef<str>,

Delete a “folder”. if the folder contains any object, it will not be deleted

Official document: https://help.aliyun.com/zh/oss/developer-reference/deleteobject

fn get_object_metadata<S1, S2>( &self, bucket_name: S1, object_key: S2, options: Option<GetObjectMetadataOptions>, ) -> Result<ObjectMetadata>

where S1: AsRef<str>, S2: AsRef<str>,

Get object metadata

Official document: https://help.aliyun.com/zh/oss/developer-reference/getobjectmeta

fn exists<S1, S2>( &self, bucket_name: S1, object_key: S2, options: Option<GetObjectMetadataOptions>, ) -> Result<bool>

where S1: AsRef<str>, S2: AsRef<str>,

Check if the object exists or not using get object metadata

Official document: https://help.aliyun.com/zh/oss/developer-reference/getobjectmeta

fn head_object<S1, S2>( &self, bucket_name: S1, object_key: S2, options: Option<HeadObjectOptions>, ) -> Result<ObjectMetadata>

where S1: AsRef<str>, S2: AsRef<str>,

Head object

Official document: https://help.aliyun.com/zh/oss/developer-reference/headobject

fn copy_object<S1, S2, S3, S4>( &self, source_bucket_name: S1, source_object_key: S2, dest_bucket_name: S3, dest_object_key: S4, options: Option<CopyObjectOptions>, ) -> Result<CopyObjectResult>

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>, S4: AsRef<str>,

Copy files (Objects) between the same or different Buckets within the same region.

Official document: https://help.aliyun.com/zh/oss/developer-reference/copyobject

fn delete_object<S1, S2>( &self, bucket_name: S1, object_key: S2, options: Option<DeleteObjectOptions>, ) -> Result<DeleteObjectResult>

where S1: AsRef<str>, S2: AsRef<str>,

Delete an object

Official document: https://help.aliyun.com/zh/oss/developer-reference/deleteobject

fn delete_multiple_objects<S1, S2>( &self, bucket_name: S1, config: DeleteMultipleObjectsConfig<'_, S2>, ) -> Result<DeleteMultipleObjectsResult>

where S1: AsRef<str>, S2: AsRef<str>,

Delete multiple objects

Official document: https://help.aliyun.com/zh/oss/developer-reference/deletemultipleobjects

fn restore_object<S1, S2>( &self, bucket_name: S1, object_key: S2, config: RestoreObjectRequest, ) -> Result<RestoreObjectResult>

where S1: AsRef<str>, S2: AsRef<str>,

Restore object

Official document: https://help.aliyun.com/zh/oss/developer-reference/restoreobject

fn clean_restored_object<S1, S2>( &self, bucket_name: S1, object_key: S2, ) -> Result<()>

where S1: AsRef<str>, S2: AsRef<str>,

Clean retored object

Official document: https://help.aliyun.com/zh/oss/developer-reference/cleanrestoredobject

impl ObjectSymlinkOperations for Client

fn put_symlink<S1, S2, S3>( &self, bucket_name: S1, symlink_object_key: S2, target_object_key: S3, options: Option<PutSymlinkOptions>, ) -> Result<PutSymlinkResult>

where S1: AsRef<str>, S2: AsRef<str>, S3: AsRef<str>,

Put a symlink object.

target_object_key should be a full and valid object key.

Official document: https://help.aliyun.com/zh/oss/developer-reference/putsymlink

fn get_symlink<S1, S2>( &self, bucket_name: S1, symlink_object_key: S2, options: Option<GetSymlinkOptions>, ) -> Result<String>

where S1: AsRef<str>, S2: AsRef<str>,

Get a symlink object. The returned string is the target object key

Official document: https://help.aliyun.com/zh/oss/developer-reference/getsymlink

impl ObjectTagOperations for Client

fn get_object_tags<S1, S2>( &self, bucket_name: S1, object_key: S2, options: Option<GetObjectTagOptions>, ) -> Result<HashMap<String, String>>

where S1: AsRef<str>, S2: AsRef<str>,

Get object taggings

Official document: https://help.aliyun.com/zh/oss/developer-reference/getobjecttagging

fn put_object_tags<S1, S2>( &self, bucket_name: S1, object_key: S2, tags: HashMap<String, String>, options: Option<PutObjectTagOptions>, ) -> Result<()>

where S1: AsRef<str>, S2: AsRef<str>,

Put object taggings

Official document: https://help.aliyun.com/zh/oss/developer-reference/putobjecttagging

fn delete_object_tags<S1, S2>( &self, bucket_name: S1, object_key: S2, options: Option<DeleteObjectTagOptions>, ) -> Result<()>

where S1: AsRef<str>, S2: AsRef<str>,

Delete object taggings

Official document: https://help.aliyun.com/zh/oss/developer-reference/deleteobjecttagging