该 google-pagespeedonline2 库允许访问 Google pagespeedonline 服务中的所有功能。

此文档是从 pagespeedonline crate 版本 5.0.5+20191206 生成的，其中 20191206 是由 mako 代码生成器 v5.0.5 构建的 pagespeedonline:v2 架构的确切修订版本。

有关 pagespeedonline v2 API 的其他信息，请参阅官方文档网站。

功能

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

• pagespeedapi
• runpagespeed

本库的结构

API 被结构化为主项以下

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

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

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

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

或具体地说...

let r = hub.pagespeedapi().runpagespeed(...).doit().await

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

用法

设置你的项目

要使用此库，你需要在你的Cargo.toml文件中添加以下行

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_pagespeedonline2 as pagespeedonline2;
use pagespeedonline2::{Result, Error};
use std::default::Default;
use pagespeedonline2::{Pagespeedonline, 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 = Pagespeedonline::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.pagespeedapi().runpagespeed("url")
             .strategy("magna")
             .screenshot(true)
             .add_rule("voluptua.")
             .locale("At")
             .filter_third_party_resources(false)
             .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()方法的返回值的Result枚举提供，或者作为可能的中间结果传递给Hub Delegate或Authenticator Delegate。

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

上传和下载

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

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

定制和回调

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

委托特质（delegate trait）默认实现，让您以最少的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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