38 个版本 (稳定版)

5.0.5+20181005 2024年6月27日
5.0.4+20181005 2024年3月5日
5.0.3+20181005 2023年8月23日
5.0.2+20181005 2023年3月16日
0.1.9+20150831 2015年10月19日

#2813 in 网页编程

Download history 4/week @ 2024-05-19 3/week @ 2024-06-02 1/week @ 2024-06-09 85/week @ 2024-06-23 43/week @ 2024-06-30

每月下载量 2,211
用于 google-appengine1_beta4-c…

MIT 许可证

440KB
5.5K SLoC

《google-appengine1_beta4》库允许访问 Google appengine 服务的所有功能。

本文档由 appengine crate 版本 5.0.5+20181005 生成,其中 20181005 是由 mako 代码生成器 v5.0.5 构建的 appengine:v1beta4 模式的确切修订版本。

有关 appengine v1_beta4 API 的其他信息,请参阅官方文档网站

功能

从中央 中心 简单易用地处理以下 资源 ...

本库的结构

API 结构如下主要项目

  • 枢纽
  • 资源
    • 你可以应用 活动 到的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 从未直接用于 活动
  • 活动
    • 应用于 资源 的操作

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

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

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

或者具体地说 ...

let r = hub.apps().modules_versions_instances_debug(...).doit().await
let r = hub.apps().modules_versions_instances_delete(...).doit().await
let r = hub.apps().modules_versions_create(...).doit().await
let r = hub.apps().modules_versions_delete(...).doit().await
let r = hub.apps().modules_versions_patch(...).doit().await
let r = hub.apps().modules_delete(...).doit().await
let r = hub.apps().modules_patch(...).doit().await
let r = hub.apps().operations_get(...).doit().await
let r = hub.apps().create(...).doit().await
let r = hub.apps().patch(...).doit().await

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

用法

设置你的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_appengine1_beta4 as appengine1_beta4;
use appengine1_beta4::api::DebugInstanceRequest;
use appengine1_beta4::{Result, Error};
use std::default::Default;
use appengine1_beta4::{Appengine, 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 = Appengine::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 = DebugInstanceRequest::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.apps().modules_versions_instances_debug(req, "appsId", "modulesId", "versionsId", "instancesId")
             .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 枚举返回值提供,或者作为可能的中继结果传递给 Hub DelegateAuthenticator Delegate

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

上传和下载

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

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

定制和回调

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

delegate trait 具有默认实现,允许您以最小的努力进行定制。

服务器请求中的可选部分

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

构建器参数

使用 method builders,您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受单个参数,以下语句对它成立。

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

Cargo 功能

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

许可证

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

依赖项

~12–22MB
~341K SLoC