16 个稳定版本 (4 个主要版本)
5.0.5+20240626 | 2024年6月27日 |
---|---|
5.0.4+20240303 | 2024年3月5日 |
5.0.3+20230121 | 2023年8月23日 |
5.0.2+20230121 | 2023年3月16日 |
1.0.10+20190703 | 2019年7月6日 |
#2517 in 网页编程
1,014 每月下载量
用于 google-factchecktools1_al…
200KB
2.5K SLoC
google-factchecktools1_alpha1
库允许访问 Google 事实核查工具服务的所有功能。
本文档是从 Fact Check Tools 框架版本 5.0.5+20240626 生成的,其中 20240626 是由 mako 代码生成器 v5.0.5 构建的 factchecktools:v1alpha1 架构的确切修订版。
有关 Fact Check Tools v1_alpha1 API 的其他信息,请参阅 官方文档网站。
功能
从中央 枢纽 简单地处理以下 资源...
此库的结构
API 结构如下主要项目
所有 结构 都用适用的特性标记,以便进一步分类并方便浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或者具体...
let r = hub.pages().create(...).doit().await
let r = hub.pages().get(...).doit().await
let r = hub.pages().update(...).doit().await
resource()
和 activity(...)
调用创建 构建器。第二个处理 活动
支持各种方法来配置即将进行的操作(此处未显示)。它被设计成必须立即指定所有必需参数(即 (...)
),而所有可选参数则可以按需 构建。doit()
方法执行与服务器实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的 Cargo.toml
文件
[dependencies]
google-factchecktools1_alpha1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_factchecktools1_alpha1 as factchecktools1_alpha1;
use factchecktools1_alpha1::api::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage;
use factchecktools1_alpha1::{Result, Error};
use std::default::Default;
use factchecktools1_alpha1::{FactCheckTools, 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 = FactCheckTools::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 = GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage::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.pages().update(req, "name")
.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(...)
。
自定义和回调
您可以通过向 Method Builder 提供一个 delegate 来改变 doit()
方法的调用方式,在最终进行 doit()
调用之前。相应的方程序将调用以提供进度信息,以及确定系统在失败时是否应重试。
默认实现了 委托特理,允许您以最小的努力进行自定义。
服务器请求中的可选部分
本库提供的所有结构都是为了能够通过 json 进行编码和解码的,以便通过 请求值 和 响应结果。可选部分用于表示部分请求或响应是有效的。大多数可选部分被视为 部分,可以通过名称识别,这些部分将被发送到服务器,以指示请求的集合部分或响应中期望的部分。
构建器参数
使用 方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法总是接受一个参数,以下陈述对它成立。
参数将被复制或克隆到构建器中,以便它们与其原始生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须将所需类型导入并注册到#[openapi(schemas(...))]
,否则生成的openapi
规范将是无效的。
许可证
factchecktools1_alpha1 库由 Sebastian Thiel 创建,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖关系
约 12-23MB
约 345K SLoC