#google-api #coordinate #google #protocols #web-api #api #web

google-coordinate1

一个用于与坐标(协议 v1)交互的完整库

42 个版本 (25 个稳定版本)

5.0.5+20150811 2024年6月27日
5.0.4+20150811 2024年3月5日
5.0.3+20150811 2023年8月23日
5.0.2+20150811 2023年3月16日
0.1.2+20141215 2015年3月25日

网页编程 中排名 2416

Download history 59/week @ 2024-06-21 34/week @ 2024-06-28 4/week @ 2024-07-05

每月下载量 2,473
用于 google-coordinate1-cli

MIT 许可证

290KB
4K SLoC

google-coordinate1 库允许访问 Google 坐标服务(协议 v1)的所有功能。

本文档由 coordinate 库版本 5.0.5+20150811 生成,其中 20150811 是由 mako 代码生成器 v5.0.5 构建的 coordinate:v1 架构的确切修订版。

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

功能

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

本库的结构

API 被组织成以下主要项目

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

所有结构都被标记上了适用的特性,以便进一步分类和方便浏览。

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

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

或者具体来说...

let r = hub.jobs().get(...).doit().await
let r = hub.jobs().insert(...).doit().await
let r = hub.jobs().list(...).doit().await
let r = hub.jobs().patch(...).doit().await
let r = hub.jobs().update(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_coordinate1 as coordinate1;
use coordinate1::api::Job;
use coordinate1::{Result, Error};
use std::default::Default;
use coordinate1::{Coordinate, 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 = Coordinate::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 = Job::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.jobs().patch(req, "teamId", 68)
             .title("no")
             .progress("ipsum")
             .note("voluptua.")
             .lng(0.5857873539022715)
             .lat(0.16568728368878083)
             .customer_phone_number("takimata")
             .customer_name("amet.")
             .add_custom_field("duo")
             .assignee("ipsum")
             .address("gubergren")
             .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()方法的返回值提供的枚举,或者作为可能的中级结果传递给Hub 代理认证代理

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

上传和下载

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

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

自定义和回调

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

委托特里特默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC