Struct Client 

pub struct Client<'a> { /* private fields */ }

Implementations

impl<'a> Client<'a>

传输加速`TransferAcceleration``

pub fn PutBucketTransferAcceleration( &self, value: bool, ) -> PutBucketTransferAccelerationBuilder<'_>

接口用于为存储空间（Bucket）配置传输加速。开启传输加速后，可提升全球各地用户对OSS的访问速度， 适用于远距离数据传输、GB或TB级大文件上传和下载的场景。

• official docs
• xtoss example

pub fn GetBucketTransferAcceleration( &self, ) -> GetBucketTransferAccelerationBuilder<'_>

接口用于获取目标存储空间（Bucket）的传输加速配置

• official docs
• xtoss example

impl<'a> Client<'a>

权限控制`ACL``

pub fn PutBucketAcl(&self, acl: OssAcl) -> PutBucketAclBuilder<'_>

PutBucketAcl接口用于设置或修改存储空间Bucket的访问权限ACL。

• official docs
• xtoss example

pub fn GetBucketAcl(&self) -> GetBucketAclBuilder<'_>

GetBucketAcl接口用于获取某个存储空间Bucket的访问权限ACL。 只有Bucket的拥有者才能获取Bucket的访问权限。

• official docs
• xtoss example

impl<'a> Client<'a>

自定义域名`CNAME``

pub fn CreateCnameToken(&self, cname: &'a str) -> CreateCnameTokenBuilder<'_>

调用CreateCnameToken接口创建域名所有权验证所需的CnameToken

• official docs
• xtoss example

pub fn GetCnameToken(&self, cname: &'a str) -> GetCnameTokenBuilder<'_>

调用GetCnameToken接口获取已创建的CnameToken

• official docs
• xtoss example

pub fn PutCname(&self) -> PutCnameBuilder<'_>

调用PutCname接口为某个存储空间(Bucket)绑定自定义域名

• official docs
• xtoss example

pub fn ListCname(&self) -> ListCnameBuilder<'_>

调用ListCname接口用于查询某个存储空间(Bucket)下绑定的所有的自定义域名(Cname)列表

• official docs
• xtoss example

pub fn DeleteCname(&self, cname: &'a str) -> DeleteCnameBuilder<'_>

调用DeleteCname接口删除某个存储空间(Bucket)已绑定的Cname

• official docs
• xtoss example

impl<'a> Client<'a>

跨域资源共享（CORS）

pub fn PutBucketCors(&self) -> PutBucketCorsBuilder<'_>

调用PutBucketCors接口为指定的存储空间Bucket设置跨域资源共享CORS Cross-Origin Resource Sharing规则

• official docs
• xtoss example

pub fn GetBucketCors(&self) -> GetBucketCorsBuilder<'_>

GetBucketCors接口用于获取指定存储空间Bucket当前的跨域资源共享CORS Cross-Origin Resource Sharing规则。

• official docs
• xtoss example

pub fn DeleteBucketCors(&self) -> DeleteBucketCorsBuilder<'_>

DeleteBucketCors用于关闭指定存储空间Bucket对应的跨域资源共享CORS Cross-Origin Resource Sharing功能并清空所有规则

• official docs
• xtoss example

pub fn Options(&self, object: &'a str) -> OptionsBuilder<'_>

浏览器在发送跨域请求之前会发送一个preflight请求Options给OSS,并带上特定的 来源域、HTTP方法和header等信息,以决定是否发送真正的请求。Options请求是由浏览 器自动根据是否跨域来决定是否发送。

• official docs
• xtoss example

impl<'a> Client<'a>

加密（Encryption）

pub fn PutBucketEncryption(&self) -> PutBucketEncryptionBuilder<'_>

PutBucketEncryption接口用于配置存储空间Bucket的加密规则。

• official docs
• xtoss example

pub fn GetBucketEncryption(&self) -> GetBucketEncryptionBuilder<'_>

GetBucketEncryption接口用于获取存储空间Bucket的加密规则。

• official docs
• xtoss example

pub fn DeleteBucketEncryption(&self) -> DeleteBucketEncryptionBuilder<'_>

DeleteBucketEncryption接口用于删除Bucket加密规则。

• official docs
• xtoss example

impl<'a> Client<'a>

生命周期`Lifecycle``

pub fn PutBucketLifecycle(&self) -> PutBucketLifecycleBuilder<'_>

您可以基于最后一次修改时间以及最后一次访问时间的策略创建生命周期规则，定期将存储空间 Bucket内的多个文件Object转储为指定存储类型,或者将过期的Object和碎片删除, 从而节省存储费用。本文为您介绍如何调用PutBucketLifecycle接口为存储空间`Bucket`` 设置生命周期规则。

• official docs
• xtoss example

pub fn GetBucketLifecycle(&self) -> GetBucketLifecycleBuilder<'_>

调用GetBucketLifecycle接口查看存储空间Bucket的生命周期规则Lifecycle。

• official docs
• xtoss example

pub fn DeleteBucketLifecycle(&self) -> DeleteBucketLifecycleBuilder<'_>

DeleteBucketLifecycle接口用于删除指定存储空间Bucket的生命周期规则。 使用DeleteBucketLifecycle接口删除指定Bucket所有的生命周期规则后, 该Bucket中的文件Object不会被自动删除。只有Bucket的拥有者才能删除该Bucket 的生命周期规则。

• official docs
• xtoss example

impl<'a> Client<'a>

日志管理`Logging``

pub fn PutBucketLogging(&self) -> PutBucketLoggingBuilder<'_>

PutBucketLogging接口用于为存储空间Bucket开启日志转存功能， 可将OSS的访问日志按照固定命名规则,以小时为单位生成日志文件写入您 指定的Bucket。

• official docs
• xtoss example

pub fn GetBucketLogging(&self) -> GetBucketLoggingBuilder<'_>

GetBucketLogging接口用于查看存储空间Bucket的访问日志配置。 只有Bucket的拥有者才能查看Bucket的访问日志配置。

• official docs
• xtoss example

pub fn DeleteBucketLogging(&self) -> DeleteBucketLoggingBuilder<'_>

DeleteBucketLogging用于关闭存储空间Bucket的访问日志记录功能。 只有Bucket的拥有者才有权限关闭Bucket访问日志记录功能

• official docs
• xtoss example

impl<'a> Client<'a>

授权策略Policy

pub fn PutBucketPolicy(&self) -> PutBucketPolicyBuilder<'_>

PutBucketPolicy接口用于为指定的存储空间Bucket设置授权策略Policy。

• official docs
• xtoss example

pub fn GetBucketPolicy(&self) -> GetBucketPolicyBuilder<'_>

GetBucketPolicy用于获取指定存储空间Bucket的权限策略Policy。

• official docs
• xtoss example

pub fn DeleteBucketPolicy(&self) -> DeleteBucketPolicyBuilder<'_>

DeleteBucketPolicy用于删除指定存储空间Bucket的权限策略Policy。

• official docs
• xtoss example

impl<'a> Client<'a>

防盗链`Referer``

pub fn PutBucketReferer(&self) -> PutBucketRefererBuilder<'_>

调用PutBucketReferer接口设置存储空间Bucket级别的Referer访问白名单以及黑名单

• official docs
• xtoss example

pub fn GetBucketReferer(&self) -> GetBucketRefererBuilder<'_>

GetBucketReferer接口用于查看存储空间Bucket的防盗链Referer相关配置。

• official docs
• xtoss example

impl<'a> Client<'a>

基础操作

pub fn PutBucket(&self) -> PutBucketBuilder<'_>

调用PutBucket接口创建存储空间Bucket。

• official docs
• xtoss example

pub fn DeleteBucket(&self) -> DeleteBucketBuilder<'_>

调用DeleteBucket删除某个存储空间Bucket。

• official docs
• xtoss example

pub fn ListObjects(&self) -> ListObjectBuilder<'_>

GetBucket (ListObjects)接口用于列举存储空间Bucket中所有文件 Object的信息。

• official docs
• xtoss example

pub fn ListObjectsV2(&self) -> ListObjectsV2Builder<'_>

ListObjectsV2GetBucketV2接口用于列举存储空间Bucket中所有文件 Object的信息。

• official docs
• xtoss example

pub fn GetBucketInfo(&self) -> GetBucketInfoBuilder<'_>

调用GetBucketInfo接口查看存储空间Bucket的相关信息。

• official docs
• xtoss example

pub fn GetBucketLocation(&self) -> GetBucketLocationBuilder<'_>

GetBucketLocation接口用于查看存储空间Bucket的位置信息。 只有Bucket的拥有者才能查看Bucket的位置信息。

• official docs
• xtoss example

pub fn GetBucketStat(&self) -> GetBucketStatBuilder<'_>

调用GetBucketStat接口获取指定存储空间Bucket的存储容量以及文件 Object数量

• official docs
• xtoss example

impl<'a> Client<'a>

图片样式Style

pub fn PutStyle(&self) -> PutStyleBuilder<'_>

调用PutStyle接口新增图片样式。一个图片样式中可以包含单个或多个图片处理参数

• official docs
• xtoss example

pub fn GetStyle(&self, name: &'a str) -> GetStyleBuilder<'_>

调用ListStyle接口查询某个Bucket下已创建的所有样式

• official docs
• xtoss example

pub fn ListStyle(&self) -> ListStyleBuilder<'_>

调用GetStyle接口查询某个Bucket下指定的样式信息

• official docs
• xtoss example

pub fn DeleteStyle(&self, name: &'a str) -> DeleteStyleBuilder<'_>

调用DeleteStyle删除某个Bucket下指定的图片样式

• official docs
• xtoss example

impl<'a> Client<'a>

标签`Tags``

pub fn PutBucketTags(&self) -> PutBucketTagsBuilder<'_>

PutBucketTags接口用来给某个存储空间Bucket添加或修改标签。

• official docs
• xtoss example

pub fn GetBucketTags(&self) -> GetBucketTagsBuilder<'_>

GetBucketTags用于获取存储空间Bucket的标签信息。

• official docs
• xtoss example

pub fn DeleteBucketTags(&self) -> DeleteBucketTagsBuilder<'_>

DeleteBucketTags接口用于删除存储空间Bucket标签。

• official docs
• xtoss example

impl<'a> Client<'a>

版本控制`Versioning``

pub fn PutBucketVersioning( &self, status: VersioningStatus, ) -> PutBucketVersioningBuilder<'_>

调用PutBucketVersioning设置指定存储空间Bucket的版本控制状态。

• official docs
• xtoss example

pub fn GetBucketVersioning(&self) -> GetBucketVersioningBuilder<'_>

接口用于获取指定Bucket的版本控制状态。

• official docs
• xtoss example

pub fn ListObjectVersions(&self) -> ListObjectVersionsBuilder<'_>

接口用于列出Bucket中包括删除标记Delete Marker在内的所有Object 的版本信息

• official docs
• xtoss example

impl<'a> Client<'a>

静态网站`Website``

pub fn PutBucketWebsite(&self) -> PutBucketWebsiteBuilder<'_>

调用PutBucketWebsite接口将存储空间Bucket设置为静态网站托管模式并设置跳 转规则RoutingRule。

• official docs
• xtoss example

pub fn GetBucketWebsite(&self) -> GetBucketWebsiteBuilder<'_>

调用GetBucketWebsite接口查看存储空间Bucket的静态网站托管状态以及跳转规则

• official docs
• xtoss example

pub fn DeleteBucketWebsite(&self) -> DeleteBucketWebsiteBuilder<'_>

DeleteBucketWebsite接口用于关闭存储空间Bucket的静态网站托管模式以及 跳转规则。只有Bucket的拥有者才能关闭Bucket的静态网站托管模式。

• official docs
• xtoss example

impl<'a> Client<'a>

合规保留策略`WORM``

pub fn InitiateBucketWorm(&self) -> InitiateBucketWormBuilder<'_>

调用InitiateBucketWorm接口新建一条合规保留策略。

• official docs
• xtoss example

pub fn AbortBucketWorm(&self) -> AbortBucketWormBuilder<'_>

AbortBucketWorm用于删除未锁定的合规保留策略。

• official docs
• xtoss example

pub fn CompleteBucketWorm( &self, worm_id: &'a str, ) -> CompleteBucketWormBuilder<'_>

CompleteBucketWorm用于锁定合规保留策略。

• official docs
• xtoss example

pub fn ExtendBucketWorm(&self, worm_id: &'a str) -> ExtendBucketWormBuilder<'_>

ExtendBucketWorm用于延长已锁定的合规保留策略对应Bucket中Object的保留天数。

• official docs
• xtoss example

pub fn GetBucketWorm(&self) -> GetBucketWormBuilder<'_>

GetBucketWorm用于获取指定存储空间Bucket的合规保留策略信息。

• official docs
• xtoss example

impl<'a> Client<'a>

请求者付费RequestPayment

pub fn PutBucketRequestPayment( &self, payer: Payer, ) -> PutBucketRequestPaymentBuilder<'_>

PutBucketRequestPayment接口用于设置请求者付费模式。

• official docs
• xtoss example

pub fn GetBucketRequestPayment(&self) -> GetBucketRequestPaymentBuilder<'_>

GetBucketRequestPayment接口用于获取请求者付费模式配置信息。

• official docs
• xtoss example

impl<'a> Client<'a>

基础操作

pub fn PutObjectACL(&self, object: &'a str) -> PutObjectACLBuilder<'_>

调用PutObjectACL接口修改文件Object的访问权限ACL。 此操作只有Bucket Owner有权限执行,且需对Object有读写权限。

• official docs
• xtoss example

pub fn GetObjectACL(&self, object: &'a str) -> GetObjectAclBuilder<'_>

调用GetObjectACL接口获取存储空间Bucket下某个文件Object的访问权限ACL。

• official docs
• xtoss example

impl<'a> Client<'a>

基础操作

pub fn PutObject(&self, object: &'a str) -> PutObjectBuilder<'_>

调用PutObject接口上传文件Object

• official docs
• xtoss example

pub fn GetObject(&self, object: &'a str) -> GetObjectBuilder<'_>

GetObject接口用于获取某个文件Object。此操作需要对此Object具有读权限

• official docs
• xtoss example

pub fn CopyObject(&self, object: &'a str) -> CopyObjectBuilder<'_>

调用CopyObject接口拷贝同一地域下相同或不同存储空间Bucket之间的文件Object

• official docs
• xtoss example

pub fn AppendObject(&self, object: &'a str) -> AppendObjectBuilder<'_>

调用AppendObject接口用于以追加写的方式上传文件Object。通过AppendObject操

• official docs
• xtoss example

pub fn DeleteObject(&self, object: &'a str) -> DeleteObjectBuilder<'_>

调用DeleteObject删除某个文件Object

• official docs
• xtoss example

pub fn DeleteMultipleObjects(&self) -> DeleteMultipleObjectsBuilder<'_>

DeleteMultipleObjects接口用于删除同一个存储空间Bucket中的多个文件Object

• official docs
• xtoss example

pub fn HeadObject(&self, object: &'a str) -> HeadObjectBuilder<'_>

HeadObject接口用于获取某个文件Object的元信息

• official docs
• xtoss example

pub fn GetObjectMeta(&self, object: &'a str) -> GetObjectMetaBuilder<'_>

调用GetObjectMeta接口获取一个文件Object的元数据信息 包括该Object的ETag、Size、LastModified信息,并且不返回该Object的内容。

• official docs
• xtoss example

pub fn RestoreObject(&self, object: &'a str) -> RestoreObjectBuilder<'_>

调用RestoreObject接口解冻归档类型、冷归档、深度冷归档类型的文件Object

• official docs
• xtoss example

impl<'a> Client<'a>

基础操作

pub fn InitiateMultipartUpload( &self, object: &'a str, ) -> InitiateMultipartUploadBuilder<'_>

使用Multipart Upload模式传输数据前,您必须先调用InitiateMultipartUpload接口来通知OSS初始化一 个Multipart Upload事件。

• official docs
• xtoss example

pub fn UploadPart(&self, object: &'a str) -> UploadPartBuilder<'_>

初始化一个MultipartUpload后,调用UploadPart接口根据指定的Object名和uploadId来分块Part上传数据。

• official docs
• xtoss example

pub fn UploadPartCopy(&self) -> UploadPartCopyBuilder<'_>

通过在UploadPart请求的基础上增加一个请求头x-oss-copy-source来调用UploadPartCopy接口,实现从一个 已存在的Object中拷贝数据来上传一个Part。

• official docs
• xtoss example

pub fn CompleteMultipartUpload( &self, object: &'a str, ) -> CompleteMultipartUploadBuilder<'_>

在将所有数据Part都上传完成后,您必须调用CompleteMultipartUpload接口来完成整个文件的分片上传。

• official docs
• xtoss example

pub fn AbortMultipartUpload( &self, object: &'a str, ) -> AbortMultipartUploadBuilder<'_>

AbortMultipartUpload接口用于取消MultipartUpload事件并删除对应的Part数据。

• official docs
• xtoss example

pub fn ListMultipartUploads(&self) -> ListMultipartUploadsBuilder<'_>

调用ListMultipartUploads接口列举所有执行中的Multipart Upload事件,即已经初始化但还未完成 Complete或者还未中止Abort的Multipart Upload事件。

• official docs
• xtoss example

pub fn ListParts(&self, object: &'a str) -> ListPartsBuilder<'_>

ListParts接口用于列举指定Upload ID所属的所有已经上传成功Part。

• official docs
• xtoss example

impl<'a> Client<'a>

软链接`Symlink``

pub fn PutSymlink(&self, object: &'a str) -> PutSymlinkBuilder<'_>

调用PutSymlink接口用于为OSS的目标文件TargetObject创建软链接 Symlink,您可以通过该软链接访问TargetObject。

• official docs
• xtoss example

pub fn GetSymlink(&self, object: &'a str) -> GetSymlinkBuilder<'_>

调用GetSymlink接口获取软链接。此操作需要您对该软链接有读权限。

• official docs
• xtoss example

impl<'a> Client<'a>

标签Tagging

pub fn PutObjectTagging(&self, object: &'a str) -> PutObjectTaggingBuilder<'_>

调用PutObjectTagging接口设置或更新对象Object的标签Tagging信息。 对象标签使用一组键值对Key-Value标记对象。

• official docs
• xtoss example

pub fn GetObjectTagging(&self, object: &'a str) -> GetObjectTaggingbuilder<'_>

调用GetObjectTagging接口获取对象Object的标签Tagging信息。

• official docs
• xtoss example

pub fn DeleteObjectTagging( &self, object: &'a str, ) -> DeleteObjectTaggingBuilder<'_>

调用DeleteObjectTagging接口删除指定对象Object的标签Tagging信息。

• official docs
• xtoss example

impl<'a> Client<'a>

关于Service操作

pub fn DescribeRegions(&self) -> DescribeRegionsBuilder<'_>

调用DescribeRegions接口查询所有支持地域或者指定地域对应的Endpoint信息, 包括外网Endpoint、内网Endpoint和传输加速Endpoint。

• official docs
• xtoss example

impl<'a> Client<'a>

关于Region操作

pub fn ListBuckets(&self) -> ListBucketsBuilder<'_>

调用ListBuckets（GetService）接口列举请求者拥有的所有存储空间（Bucket）。 您还可以通过设置prefix、marker或者max-keys参数列举满足指定条件的存储空间。

• official docs
• xtoss example

impl<'a> Client<'a>

pub fn new(options: Options<'a>) -> Self

pub fn options(&self) -> &Options<'_>

pub fn region(&self) -> &'a str

pub fn bucket(&self) -> &'a str

pub fn root_url(&self) -> String

pub fn base_url(&self) -> String

pub fn object_url(&self, object: &'a str) -> String

pub fn timeout(&self) -> u64

Trait Implementations

impl<'a> Clone for Client<'a>

fn clone(&self) -> Client<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Client<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Client<'a>

fn default() -> Client<'a>

Returns the “default value” for a type.