google-proximitybeacon1_beta1 库允许访问 Google proximitybeacon 服务所有功能。

此文档是从 proximitybeacon crate 版本 5.0.5+20200127 生成的，其中 20200127 是由 mako 代码生成器 v5.0.5 构建的 proximitybeacon:v1beta1 架构的精确版本。

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

功能

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

• beaconinfo
• getforobserved
• beacons
• 激活，批量删除附件，创建附件，删除附件，列出附件，停用，退役，删除，诊断列表，获取，列出，注册以及更新
• 命名空间
• 列出和更新

其他活动...

• 获取eidparams

库结构

API结构如下主要项

• Hub
  • 一个中心对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，进而允许访问单个调用构建器
• 资源
  • 可以应用活动的主要类型
  • 属性和部分的集合
  • 部分
    • 属性的集合
    • 从未在活动中直接使用
• 活动
  • 应用于资源的操作

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

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

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

或具体...

let r = hub.beacons().attachments_batch_delete(...).doit().await
let r = hub.beacons().attachments_create(...).doit().await
let r = hub.beacons().attachments_delete(...).doit().await
let r = hub.beacons().attachments_list(...).doit().await
let r = hub.beacons().diagnostics_list(...).doit().await
let r = hub.beacons().activate(...).doit().await
let r = hub.beacons().deactivate(...).doit().await
let r = hub.beacons().decommission(...).doit().await
let r = hub.beacons().delete(...).doit().await
let r = hub.beacons().get(...).doit().await
let r = hub.beacons().list(...).doit().await
let r = hub.beacons().register(...).doit().await
let r = hub.beacons().update(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_proximitybeacon1_beta1 as proximitybeacon1_beta1;
use proximitybeacon1_beta1::{Result, Error};
use std::default::Default;
use proximitybeacon1_beta1::{Proximitybeacon, 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 = Proximitybeacon::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.beacons().diagnostics_list("beaconName")
             .project_id("magna")
             .page_token("no")
             .page_size(-55)
             .alert_filter("voluptua.")
             .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代理，或认证代理。

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

上传和下载

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

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

定制和回调

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

delegate trait()具有默认实现，这使得您可以以最小的努力进行定制。

服务器请求中的可选部分

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

构建器参数

使用方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法始终只接受一个参数，以下陈述对它适用。

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

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

Cargo功能

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

许可证

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