该 google-cloudsearch1 库允许访问 Google cloudsearch 服务的所有功能。

此文档是从 cloudsearch 集版本 0.1.6+20150416 生成的，其中 20150416 是由 mako 代码生成器 v0.1.6 构建的 cloudsearch:v1 架构的确切版本。

功能

看起来这里没有可以做的事情 ... .

该库的结构

API 被组织成以下主要项目

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

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

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

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

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

用法

设置您的项目

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

[dependencies]
google-cloudsearch1 = "*"

一个完整的示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_cloudsearch1 as cloudsearch1;

use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use cloudsearch1::Cloudsearch;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::new(),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Cloudsearch::new(hyper::Client::new(), auth);

处理错误

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

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

上传和下载

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

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

定制和回调

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

delegate trait具有默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用method builders，您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受单个参数，以下陈述对它都是真实的。

• PODs通过复制传递
• 字符串作为&str传递
• 请求值被借用

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

许可证

cloudsearch1 库由 Sebastian Thiel 创建，并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。