qiniu_upload_token/
lib.rs

1#![cfg_attr(feature = "docs", feature(doc_cfg))]
2#![deny(
3    missing_debug_implementations,
4    large_assignments,
5    exported_private_dependencies,
6    absolute_paths_not_starting_with_crate,
7    anonymous_parameters,
8    explicit_outlives_requirements,
9    keyword_idents,
10    macro_use_extern_crate,
11    meta_variable_misuse,
12    missing_docs,
13    non_ascii_idents,
14    indirect_structural_match,
15    trivial_casts,
16    unreachable_pub,
17    unsafe_code,
18    unused_crate_dependencies,
19    unused_extern_crates,
20    unused_import_braces,
21    unused_lifetimes,
22    unused_qualifications
23)]
24
25//! # qiniu-upload-token
26//!
27//! ## 七牛 上传策略 / 上传凭证 库
28//!
29//! 负责配置七牛对象上传所需要的上传策略，并提供生成上传凭证的库函数，同时提供 [`UploadTokenProvider`] 方便扩展获取上传凭证的方式。
30//! 同时提供阻塞接口和异步接口（异步接口需要启用 `async` 功能）。
31//! 提供 [`UploadTokenProvider`] 的多个实现方式，例如：
32//!
33//! - [`StaticUploadTokenProvider`] : 根据其他服务计算得到的上传凭证字符串生成上传凭证
34//! - [`FromUploadPolicy`] : 根据给出的上传策略和认证信息生成上传凭证
35//! - [`BucketUploadTokenProvider`] : 基于存储空间和认证信息即时生成上传凭证
36//! - [`ObjectUploadTokenProvider`] : 基于存储空间，对象名称和认证信息即时生成上传凭证
37//! - [`CachedUploadTokenProvider`] : 缓存生成的上传凭证，不必每次都即时生成
38//!
39//! ### 代码示例
40//!
41//! #### 创建上传策略，并基于该策略创建凭证
42//!
43//! ```
44//! use qiniu_upload_token::{FileType, UploadPolicy, credential::Credential, prelude::*};
45//! use std::time::Duration;
46//!
47//! # fn main() -> anyhow::Result<()> {
48//! let upload_policy = UploadPolicy::new_for_object("your-bucket", "your-key", Duration::from_secs(3600))
49//!     .file_type(FileType::InfrequentAccess)
50//!     .build();
51//! let credential = Credential::new("your-access-key", "your-secret-key");
52//! let upload_token = upload_policy.into_static_upload_token_provider(credential, Default::default());
53//! println!("{}", upload_token);
54//! # Ok(())
55//! # }
56//! ```
57//!
58//! #### 从其他应用程序生成的上传凭证解析出上传策略
59//!
60//! ```
61//! use qiniu_upload_token::{StaticUploadTokenProvider, prelude::*};
62//!
63//! # fn main() -> anyhow::Result<()> {
64//! let upload_token: StaticUploadTokenProvider = "your-access-key:qRD-BSf_XGtovGsuOePTc1EKJo8=:eyJkZWFkbGluZSI6MTY0NzgyODY3NCwic2NvcGUiOiJ5b3VyLWJ1Y2tldC1uYW1lIn0=".parse()?;
65//! let access_key = upload_token.access_key(Default::default())?;
66//! let bucket_name = upload_token.bucket_name(Default::default())?;
67//! let upload_policy = upload_token.policy(Default::default())?;
68//! # Ok(())
69//! # }
70//! ```
71mod file_type;
72mod upload_policy;
73mod upload_token;
74pub use file_type::FileType;
75pub use qiniu_credential::{self as credential, Extensions};
76pub use qiniu_utils::{BucketName, ObjectName};
77pub use serde_json;
78pub use upload_policy::{UploadPolicy, UploadPolicyBuilder};
79pub use upload_token::{
80    BucketUploadTokenProvider, BucketUploadTokenProviderBuilder, CachedUploadTokenProvider, FromUploadPolicy,
81    GetAccessKeyOptions, GetPolicyOptions, GotAccessKey, GotUploadPolicy, ObjectUploadTokenProvider,
82    ObjectUploadTokenProviderBuilder, ParseError, ParseResult, StaticUploadTokenProvider, ToStringError,
83    ToStringOptions, ToStringResult, UploadTokenProvider, UploadTokenProviderExt,
84};
85
86/// 将所有 Trait 全部重新导出，方便统一导入
87pub mod prelude {
88    pub use super::{UploadTokenProvider, UploadTokenProviderExt};
89}
qiniu_upload_token/lib.rs

qiniu_upload_token/
lib.rs
