18 个稳定版本 (4 个主要版本)

5.0.5+20240604 2024年6月27日
5.0.4+20240227 2024年3月5日
5.0.3+20230117 2023年8月23日
5.0.2+20230117 2023年3月16日
1.0.8+20181005 2018年10月14日

#2517网页编程

Download history 4/week @ 2024-05-17 1/week @ 2024-05-24 1/week @ 2024-06-07 62/week @ 2024-06-21 29/week @ 2024-06-28

1,125 每月下载量
用于 google-indexing3-cli

MIT 许可证

115KB
1.5K SLoC

google-indexing3 库允许访问 Google 索引服务(协议 v3)的所有功能。

此文档是从 Indexingcrate 版本 5.0.5+20240604 生成的,其中 20240604 是由 mako 代码生成器 v5.0.5 构建的 indexing:v3 方案的精确版本。

有关索引 v3 API 的其他信息,请参阅 官方文档网站

功能

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

本库的结构

API 结构如下主要项

  • 中心
  • 资源
    • 可以将 活动 应用到的基类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 不会在 活动 中直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体来说 ...

let r = hub.url_notifications().get_metadata(...).doit().await
let r = hub.url_notifications().publish(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_indexing3 as indexing3;
use indexing3::{Result, Error};
use std::default::Default;
use indexing3::{Indexing, 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 = Indexing::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.url_notifications().get_metadata()
             .url("et")
             .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 DelegateAuthenticator Delegate

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

上传和下载

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

支持上传的方法可以使用最多两种不同的协议:简单可重试。每种的独特之处体现在定制的 doit(...) 方法上,分别命名为 upload(...)upload_resumable(...)

定制和回调

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

delegate trait 默认实现,允许您以最小的努力对其进行自定义。

服务器请求中的可选部分

本库提供的所有结构都设计为可通过json进行编码解码。使用可选参数来表示部分请求和响应是有效的。大多数可选参数被视为部分,可以通过名称识别,这些部分将被发送到服务器,以指示请求的设置部分或响应中期望的部分。

构建器参数

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

  • 简单数据结构(PODs)通过复制传递
  • 字符串作为&str传递
  • 请求值将被移动

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

Cargo 功能

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

许可证

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

依赖项

~12–23MB
~343K SLoC