google-firestore1_beta1 库允许访问 Google Firestore 服务的所有功能。

本文档是从 Firestore 库版本 5.0.5+20240617 生成的，其中 20240617 是由 mako 代码生成器 v5.0.5 构建的 firestore:v1beta1 架构的精确修订。

关于 Firestore v1_beta1 API 的其他所有信息，请参阅 官方文档网站。

功能

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

• 项目
• 数据库文档批量获取，数据库文档批量写入，数据库文档开始事务，数据库文档提交，数据库文档创建文档，数据库文档删除，数据库文档获取，数据库文档列表，数据库文档列表集合ID，数据库文档列表文档，数据库文档监听，数据库文档分区查询，数据库文档修补，数据库文档回滚，数据库文档运行聚合查询，数据库文档运行查询，数据库文档写入，数据库导出文档，数据库导入文档，数据库索引创建，数据库索引删除，数据库索引获取和数据库索引列表

该库的结构

API结构如下几个主要部分

• 枢纽
  • 一个中心对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，这又允许访问单个调用构建器
• 资源
  • 主要类型，可以将活动应用于其上
  • 一系列属性和部分
  • 部分
    • 一系列属性
    • 从不直接用于活动
• 活动
  • 应用于资源的操作

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

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

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

或者具体地说...

let r = hub.projects().databases_indexes_create(...).doit().await
let r = hub.projects().databases_export_documents(...).doit().await
let r = hub.projects().databases_import_documents(...).doit().await

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

使用方法

设置你的项目

要使用此库，你将以下行放入你的Cargo.toml文件中

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_firestore1_beta1 as firestore1_beta1;
use firestore1_beta1::api::GoogleFirestoreAdminV1beta1Index;
use firestore1_beta1::{Result, Error};
use std::default::Default;
use firestore1_beta1::{Firestore, 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 = Firestore::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 = GoogleFirestoreAdminV1beta1Index::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().databases_indexes_create(req, "parent")
             .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。

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

上传和下载

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

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

定制和回调

你可以通过在最终doit()调用之前向Method Builder提供一个委托来改变doit()方法的调用方式。相应的方 法将被调用以提供进度信息，并确定系统在失败时是否应该重试。

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

许可证

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