18个稳定版本 (4个主要版本)

5.0.5+20240625	2024年6月27日
5.0.4+20240303	2024年3月5日
5.0.3+20230123	2023年8月23日
5.0.2+20230123	2023年3月16日
1.0.8+20181011	2018年10月14日

在认证中排名第 834

每月下载量 21 次
用于 google-firebasehosting1_b…

MIT 许可证

1MB
13K SLoC

google-firebasehosting1_beta1 库允许访问Google Firebase Hosting服务的所有功能。

本文档是从Firebase Hosting crate版本 5.0.5+20240625 生成的，其中 20240625 是由mako代码生成器 v5.0.5 构建的 firebasehosting:v1beta1 架构的确切修订版。

有关Firebase Hosting v1_beta1 API的所有其他信息，请参阅官方文档站点。

功能

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

本库的结构

API结构为以下主要项

枢纽
- 一个中心对象，用于维护状态和访问所有活动
- 创建方法构建器，这些构建器反过来允许访问单个调用构建器
资源
- 可以应用活动的主要类型
- 一系列属性和部分
- 部分
  - 一系列属性
  - 在活动中 never 直接使用
活动
- 应用于资源的操作

所有结构都带有适用的特性，以进一步分类它们并简化浏览。

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

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

或具体来说 ...

let r = hub.projects().sites_create(...).doit().await
let r = hub.projects().sites_get(...).doit().await
let r = hub.projects().sites_patch(...).doit().await
let r = hub.sites().channels_releases_create(...).doit().await
let r = hub.sites().channels_releases_get(...).doit().await
let r = hub.sites().channels_releases_list(...).doit().await
let r = hub.sites().channels_create(...).doit().await
let r = hub.sites().channels_delete(...).doit().await
let r = hub.sites().channels_get(...).doit().await
let r = hub.sites().channels_list(...).doit().await
let r = hub.sites().channels_patch(...).doit().await
let r = hub.sites().domains_create(...).doit().await
let r = hub.sites().domains_delete(...).doit().await
let r = hub.sites().domains_get(...).doit().await
let r = hub.sites().domains_list(...).doit().await
let r = hub.sites().domains_update(...).doit().await
let r = hub.sites().releases_create(...).doit().await
let r = hub.sites().releases_get(...).doit().await
let r = hub.sites().releases_list(...).doit().await
let r = hub.sites().versions_files_list(...).doit().await
let r = hub.sites().versions_clone(...).doit().await
let r = hub.sites().versions_create(...).doit().await
let r = hub.sites().versions_delete(...).doit().await
let r = hub.sites().versions_get(...).doit().await
let r = hub.sites().versions_list(...).doit().await
let r = hub.sites().versions_patch(...).doit().await
let r = hub.sites().versions_populate_files(...).doit().await
let r = hub.sites().get_config(...).doit().await
let r = hub.sites().update_config(...).doit().await

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

用法

设置您的项目

要使用这个库，您需要在您的Cargo.toml文件中添加以下几行

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_firebasehosting1_beta1 as firebasehosting1_beta1;
use firebasehosting1_beta1::api::Site;
use firebasehosting1_beta1::{Result, Error};
use std::default::Default;
use firebasehosting1_beta1::{FirebaseHosting, 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 = FirebaseHosting::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 = Site::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().sites_create(req, "parent")
             .validate_only(true)
             .site_id("voluptua.")
             .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 Delegate或Authenticator Delegate。

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

上传和下载

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

支持上传的方法可以使用多达2种不同的协议进行上传：简单和可恢复。每种协议的独特性由定制的doit(...)方法表示，分别命名为upload(...)和upload_resumable(...)。

自定义和回调

您可以通过在最终doit()调用之前向Method Builder提供代理来更改doit()方法调用的方式。相应的方法则会被调用以提供进度信息，并确定系统在失败时是否应该重试。

默认实现了代理特质，让您以最少的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器，您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受单个参数，以下陈述对它适用。

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

参数将始终复制或克隆到构建器中，以确保它们与其原始生命周期独立。

Cargo 特性

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

许可证

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

依赖项

~12–23MB
~343K SLoC