#google-api #google #protocols #web #web-api #api #vectortile

google-vectortile1

一个完整的库,用于与语义瓦片(协议 v1)交互

12个稳定版本 (4个主要版本)

5.0.5+20210331 2024年6月27日
5.0.4+20210331 2024年3月5日
5.0.3+20210331 2023年8月24日
5.0.2+20210331 2023年3月16日
1.0.14+20200707 2020年7月10日

#2725 in 网页编程


google-vectortile1-cli 中使用

MIT 许可证

160KB
2K SLoC

google-vectortile1 库允许访问 Google 语义瓦片服务所有功能。

本文档由 语义瓦片 库版本 5.0.5+20210331 生成,其中 20210331 是由 mako 代码生成器 v5.0.5 构建的 vectortile:v1 方案的精确修订。

有关 语义瓦片 v1 API 的其他信息,请参阅 官方文档网站

特性

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

本库的结构

API 结构如下

  • 中心
  • 资源
    • 您可以将 活动 应用于的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中 never 直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体地 ...

let r = hub.featuretiles().get(...).doit().await

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

用法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_vectortile1 as vectortile1;
use vectortile1::{Result, Error};
use std::default::Default;
use vectortile1::{SemanticTile, 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 = SemanticTile::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), 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.featuretiles().get("name")
             .region_code("magna")
             .language_code("no")
             .enable_unclipped_buildings(true)
             .enable_private_roads(false)
             .enable_political_features(true)
             .enable_modeled_volumes(true)
             .enable_feature_names(true)
             .enable_detailed_highway_types(true)
             .client_tile_version_id("Lorem")
             .client_info_user_id("gubergren")
             .client_info_platform("eos")
             .client_info_operating_system("dolor")
             .client_info_device_model("ea")
             .client_info_application_version("ipsum")
             .client_info_application_id("invidunt")
             .client_info_api_client("amet")
             .always_include_building_footprints(true)
             .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 DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们可能会有机会指示系统重试。这使得系统可能对各种错误具有弹性。

上传和下载

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

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖项

~12–22MB
~341K SLoC