#google-maps #google-api #google #protocols #api #web-api #api-access

google-mapsengine1

一个完整的库,用于与 Maps Engine (协议 v1) 交互

12 个版本

使用旧的 Rust 2015

0.1.11+20151202 2016 年 1 月 30 日
0.1.10+20150629 2015 年 12 月 6 日
0.1.9+20150629 2015 年 8 月 8 日
0.1.8+20150414 2015 年 6 月 19 日
0.1.2+20150225 2015 年 3 月 25 日

#2 in #google-maps

37 每月下载次数

MIT 许可证

74KB
523

google-mapsengine1 库允许访问 Google Maps Engine 服务的所有功能。

本文档是根据 Maps Engine crate 版本 0.1.11+20151202 生成的,其中 20151202 是由 mako 代码生成器 v0.1.11 构建的 mapsengine:v1 架构的确切修订版本。

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

功能

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

支持通过 ... 上传

支持通过 ... 下载

本库的结构

API 被结构化为以下主要项

  • 中心
  • 资源
    • 可以应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 永远不会直接用于 活动
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体地 ...

let r = hub.tables().features_batch_insert(...).doit()
let r = hub.tables().list(...).doit()
let r = hub.tables().patch(...).doit()
let r = hub.tables().get(...).doit()
let r = hub.tables().files_insert(...).doit()
let r = hub.tables().features_batch_delete(...).doit()
let r = hub.tables().permissions_batch_delete(...).doit()
let r = hub.tables().permissions_batch_update(...).doit()
let r = hub.tables().features_list(...).doit()
let r = hub.tables().process(...).doit()
let r = hub.tables().upload(...).doit()
let r = hub.tables().delete(...).doit()
let r = hub.tables().parents_list(...).doit()
let r = hub.tables().features_batch_patch(...).doit()
let r = hub.tables().permissions_list(...).doit()
let r = hub.tables().features_get(...).doit()
let r = hub.tables().create(...).doit()

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

用法

设置您的项目

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

[dependencies]
google-mapsengine1 = "*"

一个完整的示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_mapsengine1 as mapsengine1;
use mapsengine1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use mapsengine1::MapsEngine;

// 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 = MapsEngine::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.tables().list()
             .tags("eirmod")
             .search("sit")
             .role("Stet")
             .project_id("sed")
             .processing_status("et")
             .page_token("dolores")
             .modified_before("kasd")
             .modified_after("accusam")
             .max_results(93)
             .creator_email("justo")
             .created_before("amet.")
             .created_after("erat")
             .bbox("labore")
             .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 DelegateAuthenticator Delegate

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

上传和下载

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

支持上传的方法可以使用最多2种不同的协议:简单可恢复。每种协议的独特性通过定制的doit(...)方法体现,这些方法分别命名为upload(...)upload_resumable(...)

自定义和回调

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

代理特质默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对参数是真实的。

  • PODs通过复制传递
  • 字符串作为&str传递
  • 请求值是移动的

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

许可

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

依赖关系

~19–30MB
~582K SLoC