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

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

关于 Firestore v1 API 的其他信息可以在 官方文档网站 找到。

功能

从中央 中心 简单地处理以下 资源 ...

• 项目
• databases backup schedules create, databases backup schedules delete, databases backup schedules get, databases backup schedules list, databases backup schedules patch, databases bulk delete documents, databases collection groups fields get, databases collection groups fields list, databases collection groups fields patch, databases collection groups indexes create, databases collection groups indexes delete, databases collection groups indexes get, databases collection groups indexes list, databases create, databases delete, databases documents batch get, databases documents batch write, databases documents begin transaction, databases documents commit, databases documents create document, databases documents delete, databases documents get, databases documents list, databases documents list collection ids, databases documents list documents, databases documents listen, databases documents partition query, databases documents patch, databases documents rollback, databases documents run aggregation query, databases documents run query, databases documents write, databases export documents, databases get, databases import documents, databases list, databases operations cancel, databases operations delete, databases operations get, databases operations list, databases patch, databases restore, locations backups delete, locations backups get, locations backups list, locations get and locations list

本库的结构

API 结构如下主要项

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

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

通常，您可以像这样调用 活动

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

或者具体地 ...

let r = hub.projects().databases_collection_groups_fields_patch(...).doit().await
let r = hub.projects().databases_collection_groups_indexes_create(...).doit().await
let r = hub.projects().databases_operations_get(...).doit().await
let r = hub.projects().databases_bulk_delete_documents(...).doit().await
let r = hub.projects().databases_create(...).doit().await
let r = hub.projects().databases_delete(...).doit().await
let r = hub.projects().databases_export_documents(...).doit().await
let r = hub.projects().databases_import_documents(...).doit().await
let r = hub.projects().databases_patch(...).doit().await
let r = hub.projects().databases_restore(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_firestore1 as firestore1;
use firestore1::api::GoogleFirestoreAdminV1Field;
use firestore1::{Result, Error};
use std::default::Default;
use firestore1::{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 = GoogleFirestoreAdminV1Field::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_collection_groups_fields_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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),
}

处理错误

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