google-gameservices1 库允许访问 Google Game Services 服务的所有功能。

本文档是从 Game Services crate 版本 5.0.5+20230105 生成的，其中 20230105 是由 mako 代码生成器 v5.0.5 构建的 gameservices:v1 方案的精确修订。

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

特性

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

• 项目
• locations game server deployments get iam policy，locations game server deployments set iam policy，locations game server deployments test iam permissions，locations get，locations list，locations operations cancel，locations operations delete，locations operations get 和 locations operations list

本库的结构

API 被结构化为以下主要项目

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

所有结构都标有适用特征，以便进一步分类并简化浏览。

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

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

或者具体...

let r = hub.projects().locations_game_server_deployments_get_iam_policy(...).doit().await
let r = hub.projects().locations_game_server_deployments_set_iam_policy(...).doit().await

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

用法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_gameservices1 as gameservices1;
use gameservices1::{Result, Error};
use std::default::Default;
use gameservices1::{GameServices, 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 = GameServices::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.projects().locations_game_server_deployments_get_iam_policy("resource")
             .options_requested_policy_version(-33)
             .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 Delegate或Authenticator Delegate。

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

上传和下载

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

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

定制和回调

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

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

服务器请求中的可选部分

此库提供的所有结构都旨在通过json进行编码和解码。使用可选来指示部分请求或响应是有效的。大多数可选都是被认为是可识别的部分，这些部分可以通过名称识别，并将发送到服务器以指示请求或响应中所需的部分。

构建器参数

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

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

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

Cargo功能

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

许可证

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