Struct qiniu_credential::Credential

pub struct Credential { /* private fields */ }

认证信息

返回认证信息的 AccessKey 和 SecretKey

Implementations

impl Credential

pub fn new(
    access_key: impl Into<AccessKey>,
    secret_key: impl Into<SecretKey>
) -> Self

创建认证信息

pub fn access_key(&self) -> &AccessKey

获取认证信息的 AccessKey

pub fn secret_key(&self) -> &SecretKey

获取认证信息的 SecretKey

pub fn split(self) -> (AccessKey, SecretKey)

同时返回认证信息的 AccessKey 和 SecretKey

pub fn sign(&self, data: &[u8]) -> String

使用七牛签名算法对数据进行签名

参考管理凭证的签名算法文档

use qiniu_credential::{Credential, prelude::*};
let credential = Credential::new("abcdefghklmnopq", "1234567890");
assert_eq!(
    credential.get(Default::default())?.sign(b"hello"),
    "abcdefghklmnopq:b84KVc-LroDiz0ebUANfdzSRxa0="
);

pub fn sign_reader(&self, reader: &mut dyn Read) -> IoResult<String>

使用七牛签名算法对输入流数据进行签名

该方法的异步版本为 Credential::sign_async_reader。

参考管理凭证的签名算法文档

use qiniu_credential::{Credential, prelude::*};
use std::io::Cursor;
let credential = Credential::new("abcdefghklmnopq", "1234567890");
assert_eq!(
    credential
        .get(Default::default())?
        .sign_reader(&mut Cursor::new(b"world"))?,
    "abcdefghklmnopq:VjgXt0P_nCxHuaTfiFz-UjDJ1AQ="
);

pub fn sign_with_data(&self, data: &[u8]) -> String

使用七牛签名算法对数据进行签名，并同时给出签名和原数据

参考上传凭证的签名算法文档

use qiniu_credential::{Credential, prelude::*};
use std::io::Cursor;
let credential = Credential::new("abcdefghklmnopq", "1234567890");
assert_eq!(
    credential.get(Default::default())?.sign_with_data(b"hello"),
    "abcdefghklmnopq:BZYt5uVRy1RVt5ZTXbaIt2ROVMA=:aGVsbG8="
);

pub fn authorization_v1_for_request(
    &self,
    url: &Uri,
    content_type: Option<&HeaderValue>,
    body: &[u8]
) -> String

使用七牛签名算法 V1 对 HTTP 请求（请求体为内存数据）进行签名，返回 Authorization 的值

use qiniu_credential::{Credential, HeaderValue, prelude::*};
use mime::APPLICATION_WWW_FORM_URLENCODED;
use std::io::Cursor;
let credential = Credential::new("abcdefghklmnopq", "1234567890");
let authorization = credential
    .get(Default::default())?
    .authorization_v1_for_request(
        &"http://upload.qiniup.com/".parse()?,
        Some(&HeaderValue::from_str(APPLICATION_WWW_FORM_URLENCODED.as_ref())?),
        b"name=test&language=go"
    );

pub fn authorization_v1_for_request_with_body_reader(
    &self,
    url: &Uri,
    content_type: Option<&HeaderValue>,
    body: &mut dyn Read
) -> IoResult<String>

使用七牛签名算法 V1 对 HTTP 请求（请求体为输入流）进行签名，返回 Authorization 的值

该方法的异步版本为 Credential::authorization_v1_for_request_with_async_body_reader。

use qiniu_credential::{Credential, HeaderValue, prelude::*};
use std::io::Cursor;
use mime::APPLICATION_WWW_FORM_URLENCODED;
let credential = Credential::new("abcdefghklmnopq", "1234567890");
let authorization = credential
    .get(Default::default())?
    .authorization_v1_for_request_with_body_reader(
        &"http://upload.qiniup.com/".parse()?,
        Some(&HeaderValue::from_str(APPLICATION_WWW_FORM_URLENCODED.as_ref())?),
        &mut Cursor::new(b"name=test&language=go")
    )?;

pub fn authorization_v2_for_request(
    &self,
    method: &Method,
    url: &Uri,
    headers: &HeaderMap,
    body: &[u8]
) -> String

使用七牛签名算法 V2 对 HTTP 请求（请求体为内存数据）进行签名，返回 Authorization 的值

use qiniu_credential::{Credential, Method, HeaderMap, HeaderValue, prelude::*};
use http::header::CONTENT_TYPE;
use mime::APPLICATION_JSON;
let credential = Credential::new("abcdefghklmnopq", "1234567890");
let mut headers = HeaderMap::new();
headers.insert(CONTENT_TYPE, HeaderValue::from_str(APPLICATION_JSON.as_ref())?);
let authorization = credential
    .get(Default::default())?
    .authorization_v2_for_request(
        &Method::GET,
        &"http://upload.qiniup.com/".parse()?,
        &headers,
        b"{\"name\":\"test\"}".as_slice(),
    );

pub fn authorization_v2_for_request_with_body_reader(
    &self,
    method: &Method,
    url: &Uri,
    headers: &HeaderMap,
    body: &mut dyn Read
) -> IoResult<String>

使用七牛签名算法 V2 对 HTTP 请求（请求体为输入流）进行签名，返回 Authorization 的值

该方法的异步版本为 Credential::authorization_v2_for_request_with_async_body_reader。

use qiniu_credential::{Credential, Method, HeaderMap, HeaderValue, prelude::*};
use http::header::CONTENT_TYPE;
use mime::APPLICATION_JSON;
use std::io::Cursor;
let credential = Credential::new("abcdefghklmnopq", "1234567890");
let mut headers = HeaderMap::new();
headers.insert(CONTENT_TYPE, HeaderValue::from_str(APPLICATION_JSON.as_ref())?);
let authorization = credential
    .get(Default::default())?
    .authorization_v2_for_request_with_body_reader(
        &Method::GET,
        &"http://upload.qiniup.com/".parse()?,
        &headers,
        &mut Cursor::new(b"{\"name\":\"test\"}")
    )?;

pub fn sign_download_url(&self, url: Uri, lifetime: Duration) -> Uri

对对象的下载 URL 签名，可以生成私有存储空间的下载地址

use qiniu_credential::{Credential, prelude::*};
use std::time::Duration;
let credential = Credential::new("abcdefghklmnopq", "1234567890");
let url = "http://www.qiniu.com/?go=1".parse()?;
let url = credential
    .get(Default::default())?
    .sign_download_url(url, Duration::from_secs(3600));
println!("{}", url);
Ok(())
}

impl Credential

pub async fn sign_async_reader(
    &self,
    reader: &mut (dyn AsyncRead + Send + Unpin)
) -> IoResult<String>

Available on crate feature async only.

使用七牛签名算法对异步输入流数据进行签名

参考管理凭证的签名算法文档

use qiniu_credential::{Credential, prelude::*};
use futures_lite::io::Cursor;
let credential = Credential::new("abcdefghklmnopq", "1234567890");
assert_eq!(
    credential
        .async_get(Default::default()).await?
        .sign_async_reader(&mut Cursor::new(b"world")).await?,
    "abcdefghklmnopq:VjgXt0P_nCxHuaTfiFz-UjDJ1AQ="
);

pub async fn authorization_v1_for_request_with_async_body_reader(
    &self,
    url: &Uri,
    content_type: Option<&HeaderValue>,
    body: &mut (dyn AsyncRead + Send + Unpin)
) -> IoResult<String>

Available on crate feature async only.

使用七牛签名算法 V1 对 HTTP 请求（请求体为异步输入流）进行签名，返回 Authorization 的值

use qiniu_credential::{Credential, HeaderValue, prelude::*};
use mime::APPLICATION_WWW_FORM_URLENCODED;
use futures_lite::io::Cursor;
let credential = Credential::new("abcdefghklmnopq", "1234567890");
let authorization = credential
    .async_get(Default::default()).await?
    .authorization_v1_for_request_with_async_body_reader(
        &"http://upload.qiniup.com/".parse()?,
        Some(&HeaderValue::from_str(APPLICATION_WWW_FORM_URLENCODED.as_ref())?),
        &mut Cursor::new(b"name=test&language=go")
    ).await?;

pub async fn authorization_v2_for_request_with_async_body_reader(
    &self,
    method: &Method,
    url: &Uri,
    headers: &HeaderMap,
    body: &mut (dyn AsyncRead + Send + Unpin)
) -> IoResult<String>

Available on crate feature async only.

使用七牛签名算法 V2 对 HTTP 请求（请求体为异步输入流）进行签名，返回 Authorization 的值

use qiniu_credential::{Credential, Method, HeaderMap, HeaderValue, prelude::*};
use http::header::CONTENT_TYPE;
use mime::APPLICATION_JSON;
use futures_lite::io::Cursor;
#[async_std::main]
let credential = Credential::new("abcdefghklmnopq", "1234567890");
let mut headers = HeaderMap::new();
headers.insert(CONTENT_TYPE, HeaderValue::from_str(APPLICATION_JSON.as_ref())?);
let authorization = credential
    .async_get(Default::default()).await?
    .authorization_v2_for_request_with_async_body_reader(
        &Method::GET,
        &"http://upload.qiniup.com/".parse()?,
        &headers,
        &mut Cursor::new(b"{\"name\":\"test\"}")
    ).await?;

Trait Implementations

impl Clone for Credential

fn clone(&self) -> Credential

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CredentialProvider for Credential

fn get(&self, _opts: GetOptions) -> IoResult<GotCredential>

返回七牛认证信息

fn async_get(
    &self,
    opts: GetOptions
) -> Pin<Box<dyn Future<Output = IoResult<GotCredential>> + Send + '_>>

Available on crate feature async only.

异步返回七牛认证信息

impl Debug for Credential

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

Formats the value using the given formatter.

impl From<Credential> for GotCredential

fn from(credential: Credential) -> Self

Converts to this type from the input type.

impl From<GotCredential> for Credential

fn from(result: GotCredential) -> Self

Converts to this type from the input type.

impl PartialEq<Credential> for Credential

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

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

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

This method tests for !=.

impl Eq for Credential

impl StructuralEq for Credential

impl StructuralPartialEq for Credential