41 个版本 (24 个稳定版本)

5.0.5+20240605 2024 年 6 月 27 日
5.0.4+20240227 2024 年 3 月 5 日
5.0.3+20221206 2023 年 8 月 24 日
5.0.2+20221206 2023 年 3 月 17 日
0.1.2+20140210 2015 年 3 月 25 日

#2759 in Web 编程


用于 google-webfonts1-cli

MIT 许可证

100KB
1.5K SLoC

“google-webfonts1”库允许访问 Google Webfonts 服务所有功能。

此文档是从 Webfonts crate 版本 5.0.5+20240605 生成的,其中 20240605 是由 mako 代码生成器 v5.0.5 构建的 webfonts:v1 架构的确切修订版本。

有关 Webfonts v1 API 的其他信息,请参阅 官方文档网站

功能

从中心 枢纽 简单地处理以下 资源...

本库结构

API 结构为以下主要项

  • 枢纽
  • 资源
    • 主要类型,您可以将 活动 应用到这些类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 从未在 活动 中直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或者具体地说...

let r = hub.webfonts().list(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_webfonts1 as webfonts1;
use webfonts1::{Result, Error};
use std::default::Default;
use webfonts1::{Webfonts, 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 = Webfonts::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.webfonts().list()
             .subset("et")
             .sort("magna")
             .add_family("no")
             .add_capability("ipsum")
             .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进行编码解码。使用可选类型来表示部分请求或响应是有效的。大多数可选类型都被视为部分,通过名称可以识别,这些部分将被发送到服务器以指示请求的集合部分或响应中期望的部分。

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~344K SLoC