40 个版本 (24 个稳定版)

5.0.5+20240626 2024年6月27日
5.0.4+20240304 2024年3月5日
5.0.3+20230124 2023年8月23日
5.0.2+20230124 2023年3月16日
0.1.2+20150208 2015年3月25日

#2 in #blogger


用于 google-blogger3-cli

MIT 许可证

585KB
8K SLoC

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

本文档是从 Blogger crate 版本 5.0.5+20240626 生成的,其中 20240626 是由 mako 代码生成器 v5.0.5 构建的 blogger:v3 架构的确切修订版。

Blogger v3 API 的其他信息可以在 官方文档网站 找到。

特性

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

库的结构

API 被组织成以下主要项目

  • 中心
  • 资源
    • 你可以将 活动 应用于的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 活动 中从不直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或者具体来说...

let r = hub.posts().delete(...).doit().await
let r = hub.posts().get(...).doit().await
let r = hub.posts().get_by_path(...).doit().await
let r = hub.posts().insert(...).doit().await
let r = hub.posts().list(...).doit().await
let r = hub.posts().patch(...).doit().await
let r = hub.posts().publish(...).doit().await
let r = hub.posts().revert(...).doit().await
let r = hub.posts().search(...).doit().await
let r = hub.posts().update(...).doit().await

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

使用方法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_blogger3 as blogger3;
use blogger3::{Result, Error};
use std::default::Default;
use blogger3::{Blogger, 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 = Blogger::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.posts().list("blogId")
             .view("magna")
             .add_status("no")
             .start_date("ipsum")
             .sort_option("voluptua.")
             .page_token("At")
             .order_by("sanctus")
             .max_results(21)
             .labels("amet.")
             .fetch_images(true)
             .fetch_bodies(true)
             .end_date("duo")
             .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")

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

定制和回调

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

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

服务器请求的可选部分

本库提供的所有结构都旨在通过 json 进行 编码解码。可选部分用于表示部分请求或响应是有效的。大多数可选部分被认为是可识别的 Parts,它们可以通过名称识别,并将发送到服务器以指示请求的设置部分或响应中所需的部分。

构建器参数

通过重复调用其方法,您可以使用 method builders 准备一个动作调用。这些方法将始终接受一个参数,以下陈述对此有效。

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

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

Cargo 特性

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

许可证

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

依赖项

~12–22MB
~341K SLoC