该 google-sourcerepo1 库允许访问 Google Cloud Source Repositories 服务的所有功能。

本文档是根据 Cloud Source Repositories crate 版本 5.0.5+20240623 生成的，其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 sourcerepo:v1 模式的确切修订版本。

有关 Cloud Source Repositories v1 API 的其他所有信息，请参阅 官方文档网站。

功能

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

• 项目
• 获取配置、创建仓库、删除仓库、获取仓库、获取 IAM 策略、列出仓库、修补仓库、设置 IAM 策略、同步仓库、测试 IAM 权限 和 更新配置

本库的结构

API 结构如下主要项目

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建方法构建器，这些构建器可以进一步访问单个调用构建器
• 资源
  • 你可以将这些活动应用于的主要类型
  • 一组属性和部分
  • 部分
    • 一组属性
    • 永远不会直接用于活动
• 活动
  • 应用于资源的操作

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

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

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

或者具体来说...

let r = hub.projects().repos_create(...).doit().await
let r = hub.projects().repos_get(...).doit().await
let r = hub.projects().repos_patch(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_sourcerepo1 as sourcerepo1;
use sourcerepo1::api::Repo;
use sourcerepo1::{Result, Error};
use std::default::Default;
use sourcerepo1::{CloudSourceRepositories, 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 = CloudSourceRepositories::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 = Repo::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.projects().repos_create(req, "parent")
             .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规范将是无效的。

许可证

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