1 个不稳定版本
使用旧的 Rust 2015
0.1.9+20150922 | 2015 年 12 月 6 日 |
---|
#224 在 #script
每月下载 23 次
47KB
522 行
google-script1
库允许访问 Google 脚本服务的所有功能。
本文档是从 script 集版本 0.1.9+20150922 生成的,其中 20150922 是由 mako 代码生成器 v0.1.9 构建的 script:v1 模式的确切修订版。
有关 script v1 API 的其他所有信息,请参阅 官方文档网站。
特性
轻松从中心 枢纽 处理以下 资源 ...
- 脚本
- 运行
本库的结构
API 被组织成以下主要项目
所有 结构 都用适用特性标记,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit()
或具体地 ...
let r = hub.scripts().run(...).doit()
resource()
和 activity(...)
调用创建 构建器。后者处理 Activities
,支持各种方法来配置即将进行的操作(此处未显示)。它被设计成必须立即指定所有必需参数(即 (...)
),而所有可选参数可以按需 构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
使用方法
设置您的项目
要使用此库,您需要将以下行放入您的 Cargo.toml
文件中
[dependencies]
google-script1 = "*"
完整示例
extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_script1 as script1;
use script1::ExecutionRequest;
use script1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use script1::Script;
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
hyper::Client::new(),
<MemoryStorage as Default>::default(), None);
let mut hub = Script::new(hyper::Client::new(), 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 = ExecutionRequest::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.scripts().run(req, "scriptId")
.doit();
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::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 提供一个 代理 来修改 doit()
方法的调用方式,然后在执行最终的 doit()
调用之前。将调用相应的方法以提供进度信息,并确定系统在失败时是否应该重试。
委托特质(delegate trait)是默认实现的,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都是为了能够通过 json 进行编码和解码。可选部分用于表示部分请求或响应是有效的。大多数可选部分都被认为是部分,可以通过名称识别,这些部分将被发送到服务器,以指示请求中设置的各个部分或期望的响应部分。
构建器参数
使用方法构建器,您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受单个参数,以下陈述适用于此参数。
- 数据结构(PODs)通过复制传递
- 字符串作为
&str
传递 - 请求值(request values)是移动的
参数将被复制或克隆到构建器中,以使它们与其原始生命周期独立。
许可证
script1 库由Sebastian Thiel生成,并置于 MIT 许可证下。您可以在存储库的许可证文件中阅读全文。
依赖项
~19–31MB
~582K SLoC