#google-api #google #api #protocols #web-api #web #firebasestorage

google-firebasestorage1_beta

一个完整的库,用于与 Firebasestorage (协议 v1beta) 交互

11 个稳定版本 (3 个主要版本)

5.0.5+20240621 2024 年 6 月 27 日
5.0.4+20240301 2024 年 3 月 5 日
5.0.3+20230106 2023 年 8 月 23 日
5.0.2+20230106 2023 年 3 月 16 日
2.0.4+20210329 2021 年 4 月 15 日

#2567 in 网页编程


google-firebasestorage1_b… 中使用

MIT 许可证

150KB
2K SLoC

“google-firebasestorage1_beta” 库允许访问 Google Firebasestorage 服务的所有功能。

本文档是根据 Firebasestorage crate 版本 5.0.5+20240621 生成的,其中 20240621 是由 mako 代码生成器 v5.0.5 构建的 firebasestorage:v1beta 模式的确切修订版。

有关 Firebasestorage v1_beta API 的其他信息,请参阅 官方文档网站

功能

从中心 枢纽 轻松处理以下 资源 ...

本库的结构

API 结构如下主要项

  • 枢纽
  • 资源
    • 可以将其应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中从未直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有适用的特性,以便进一步分类和简化浏览。

一般来说,您可以像这样调用 活动

let r = hub.resource().activity(...).doit().await

或具体地 ...

let r = hub.projects().buckets_add_firebase(...).doit().await
let r = hub.projects().buckets_get(...).doit().await

资源resource()和活动activity(...)调用创建构建器。第二个处理Activities,支持配置即将进行的操作的各种方法(此处未显示)。它是这样设计的,即所有必要的参数都必须立即指定(即(...)),而所有可选的都可以按需构建doit()方法执行与服务器的实际通信并返回相应的结果。

使用方法

设置项目

要使用此库,您需要将以下行放入您的Cargo.toml文件中

[dependencies]
google-firebasestorage1_beta = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_firebasestorage1_beta as firebasestorage1_beta;
use firebasestorage1_beta::api::AddFirebaseRequest;
use firebasestorage1_beta::{Result, Error};
use std::default::Default;
use firebasestorage1_beta::{Firebasestorage, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Firebasestorage::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = AddFirebaseRequest::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().buckets_add_firebase(req, "bucket")
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都提供为Result枚举,作为doit()方法的返回值,或者作为可能的中级结果传递给Hub DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们有机会指示系统重试。这使得系统可能对所有类型的错误都有弹性。

上传和下载

如果方法支持下载,则响应体(它是Result的一部分)应由您读取以获取媒体。如果此类方法还支持Response Result,则默认返回该结果。您可以将其视为实际媒体的元数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多2种不同的协议:简单可恢复。每种方法的特点分别由定制的doit(...)方法表示,分别命名为upload(...)upload_resumable(...)

定制和回调

您可以通过向doit()方法提供代理来修改其调用方式,在最终调用doit()之前将其提供给方法构建器。相应的函数将被调用以提供进度信息,并确定系统是否在失败时应该重试。

委托特质”默认实现,允许您以最少的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过json进行编码解码。可选部分用于表示部分请求和响应是有效的。大多数可选部分被认为是部分,可以通过名称识别,这些部分将被发送到服务器以指示请求的设置部分或响应中期望的部分。

构建器参数

使用方法构建器,您可以通过重复调用其方法来准备操作调用。这些方法始终接受单个参数,以下陈述是真实的。

  • POD通过复制传递
  • 字符串作为&str传递
  • 请求值被移动

参数将始终被复制或克隆到构建器中,以使其与其原始生命周期独立。

Cargo功能

  • utoipa - 添加对utoipa的支持,并在所有类型上派生utoipa::ToSchema。您必须在#[openapi(schemas(...))]中导入和注册所需类型,否则生成的openapi规范将是无效的。

许可证

firebasestorage1_beta”库由Sebastian Thiel生成,并置于MIT许可证下。您可以在存储库的许可证文件中阅读全文。

依赖关系

~12–23MB
~344K SLoC