10 个版本 (5 个稳定版)

使用旧的 Rust 2015

1.0.4+20151215 2017年2月4日
1.0.2+20151215 2016年12月27日
1.0.0+20151215 2016年10月16日
0.1.15+20151215 2016年9月11日
0.1.12+20151215 2016年2月28日

#291 in #web-api


google-kgsearch1-cli 中使用

MIT 许可证

66KB
753

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

此文档是从 kgsearch 包版本 1.0.4+20151215 生成的,其中 20151215 是由 mako 代码生成器 v1.0.4 构建的 kgsearch:v1 模式的确切修订版。

有关 kgsearch v1 API 的其他所有信息,请参阅 官方文档网站

特性

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

本库的结构

API 被结构化为以下主要项目

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

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

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

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

或具体地说...

let r = hub.entities().search(...).doit()

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

用法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中放入以下行

[dependencies]
google-kgsearch1 = "*"

一个完整的示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_kgsearch1 as kgsearch1;
use kgsearch1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use kgsearch1::Kgsearch;

// 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 = Kgsearch::new(hyper::Client::new(), auth);
// 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.entities().search()
             .add_types("eirmod")
             .query("sit")
             .prefix(false)
             .limit(-42)
             .add_languages("et")
             .indent(true)
             .add_ids("kasd")
             .doit();

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::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(...)

自定义和回调

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

默认实现了 代理特质,让您可以以最小的努力对其进行自定义。

服务器请求中的可选部分

此库提供的所有结构都是为了能够通过 json 进行 编码解码 而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分被视为 部分,可以通过名称进行标识,这些部分将被发送到服务器以指示请求的集合部分或响应中所需的部分。

构建器参数

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

  • PODs(原始数据结构)通过复制传递
  • 字符串作为 &str 传递
  • 请求值被移动

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

许可证

kgsearch1 库由 Sebastian Thiel 创建,并置于 MIT 许可证之下。您可以在仓库的 许可证文件 中阅读全文。

依赖关系

约 11-21MB
约 342K SLoC