Struct BucketBase

pub struct BucketBase { /* private fields */ }

Bucket 元信息

包含所属 bucket 名以及所属的 endpoint

Implementations

impl BucketBase

pub fn new(name: BucketName, endpoint: EndPoint) -> Self

初始化

pub fn set_internal(&mut self, is_internal: bool)

调整 API 指向是否为内网

当在 Aliyun ECS 上执行时，设为 true 会更高效，默认是 false

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

通过环境变量初始化

举例

use std::env::set_var;
set_var("ALIYUN_ENDPOINT", "qingdao");
set_var("ALIYUN_BUCKET", "foo1");
assert!(BucketBase::from_env().is_ok());

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

pub fn name(&self) -> &str

返回 bucket 名称的引用

pub fn get_name(&self) -> &BucketName

返回 BucketName 引用

use std::env::set_var;
set_var("ALIYUN_ENDPOINT", "qingdao");
set_var("ALIYUN_BUCKET", "foo1");
assert_eq!(
    *BucketBase::from_env().unwrap().get_name(),
    BucketName::new("foo1").unwrap()
);

pub fn endpoint(self) -> EndPoint

获取 Bucket 元信息中的可用区

pub fn endpoint_ref(&self) -> &EndPoint

获取 EndPoint 引用

pub fn set_name<N: Into<BucketName>>(&mut self, name: N)

设置 bucket name

use aliyun_oss_client::types::BucketName;
let mut bucket = BucketBase::default();
bucket.set_name("abc".parse::<BucketName>().unwrap());
assert_eq!(bucket.name(), "abc");

pub fn set_endpoint<E: Into<EndPoint>>(&mut self, endpoint: E)

为 Bucket 元信息设置可用区

pub fn try_set_name<N: TryInto<BucketName>>( &mut self, name: N, ) -> Result<(), N::Error>

设置 bucket name

let mut bucket = BucketBase::default();
assert!(bucket.try_set_name("abc").is_ok());
assert_eq!(bucket.name(), "abc");

pub fn try_set_endpoint<E: TryInto<EndPoint>>( &mut self, endpoint: E, ) -> Result<(), E::Error>

设置 endpoint

let mut bucket = BucketBase::default();
assert!(bucket.try_set_endpoint("hangzhou").is_ok());
assert_eq!(bucket.endpoint(), EndPoint::HANGZHOU);

pub fn to_url(&self) -> Url

获取url 举例

use aliyun_oss_client::types::BucketName;
let mut bucket = BucketBase::default();
bucket.set_name("abc".parse::<BucketName>().unwrap());
bucket.try_set_endpoint("shanghai").unwrap();
let url = bucket.to_url();
assert_eq!(url.as_str(), "https://abc.oss-cn-shanghai.aliyuncs.com/");

因为 BucketName,EndPoint 声明时已做限制,所以 BucketBase 可以安全的转换成 url

pub fn get_url_resource(&self, query: &Query) -> (Url, CanonicalizedResource)

根据查询参数，获取当前 bucket 的接口请求参数（ url 和 CanonicalizedResource）

pub fn get_url_resource_with_path( &self, path: &ObjectPathInner<'_>, ) -> (Url, CanonicalizedResource)

根据查询参数，获取当前 bucket 的接口请求参数（ url 和 CanonicalizedResource）

Trait Implementations

impl AsMut<BucketName> for BucketBase

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

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

impl AsMut<EndPoint> for BucketBase

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

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

impl<T: PointerFamily> AsRef<BucketBase> for Bucket<T>

fn as_ref(&self) -> &BucketBase

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

impl<T: PointerFamily, Item> AsRef<BucketBase> for ObjectList<T, Item>

fn as_ref(&self) -> &BucketBase

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

impl AsRef<BucketName> for BucketBase

fn as_ref(&self) -> &BucketName

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

impl AsRef<EndPoint> for BucketBase

fn as_ref(&self) -> &EndPoint

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

impl Clone for BucketBase

fn clone(&self) -> BucketBase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BucketBase

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

Formats the value using the given formatter.

impl Default for BucketBase

fn default() -> BucketBase

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl FromStr for BucketBase

fn from_str(domain: &str) -> Result<Self, InvalidBucketBase>

通过域名获取 举例

let bucket: BucketBase = "abc.oss-cn-shanghai.aliyuncs.com".parse().unwrap();
assert_eq!(bucket.name(), "abc");
assert_eq!(bucket.endpoint(), EndPoint::SHANGHAI);

assert!("abc*#!".parse::<BucketBase>().is_err());
assert!("abc".parse::<BucketBase>().is_err());

type Err = InvalidBucketBase

The associated error which can be returned from parsing.

impl Hash for BucketBase

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PointerFamily> PartialEq<BucketBase> for Bucket<T>

fn eq(&self, other: &BucketBase) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<Url> for BucketBase

fn eq(&self, other: &Url) -> bool

相等比较

use aliyun_oss_client::types::BucketName;
use reqwest::Url;
let mut bucket = BucketBase::default();
bucket.set_name("abc".parse::<BucketName>().unwrap());
bucket.try_set_endpoint("shanghai").unwrap();
assert!(bucket == Url::parse("https://abc.oss-cn-shanghai.aliyuncs.com/").unwrap());

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

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

impl PartialEq for BucketBase

fn eq(&self, other: &BucketBase) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&str> for BucketBase

type Error = InvalidBucketBase

The type returned in the event of a conversion error.

fn try_from(str: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for BucketBase

impl StructuralPartialEq for BucketBase