11 个稳定版本 (3 个主要版本)
5.0.5+20240614 | 2024年6月27日 |
---|---|
5.0.4+20240222 | 2024年3月5日 |
5.0.3+20230103 | 2023年8月24日 |
5.0.2+20230103 | 2023年3月16日 |
2.0.4+20210324 | 2021年4月15日 |
2410 在 网页编程
716 每月下载量
在 google-memcache1-cli 中使用
325KB
4K SLoC
google-memcache1
库允许访问 Google Cloud Memorystore for Memcached 服务的所有功能。
此文档是从 Cloud Memorystore for Memcached 包版本 5.0.5+20240614 生成的,其中 20240614 是由 mako 代码生成器 v5.0.5 构建的 memcache:v1 模式的确切修订。
有关 Cloud Memorystore for Memcached v1 API 的其他所有信息,请参阅 官方文档网站。
功能
从中心 枢纽 轻松处理以下 资源...
- 项目
- 获取位置,应用位置实例参数,创建位置实例,删除位置实例,获取位置实例,列出位置实例,更新位置实例,重新安排位置实例维护,更新位置实例参数,升级位置实例,列出位置,取消位置操作,删除位置操作,获取位置操作和列出位置操作
此库的结构
API结构如下主要项目
所有结构都标记了适用的特性和进一步分类它们以及简化浏览。
一般来说,您可以像这样调用活动
let r = hub.resource().activity(...).doit().await
或具体来说 ...
let r = hub.projects().locations_instances_apply_parameters(...).doit().await
let r = hub.projects().locations_instances_create(...).doit().await
let r = hub.projects().locations_instances_delete(...).doit().await
let r = hub.projects().locations_instances_patch(...).doit().await
let r = hub.projects().locations_instances_reschedule_maintenance(...).doit().await
let r = hub.projects().locations_instances_update_parameters(...).doit().await
let r = hub.projects().locations_instances_upgrade(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
resource()
和activity(...)
调用创建构建器。第二个处理Activities
,支持配置即将进行的操作的各种方法(此处未显示)。它使得所有必需的参数必须立即指定(即(...)
),而所有可选的参数可以按所需的方式构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您会将以下行放入您的Cargo.toml
文件
[dependencies]
google-memcache1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_memcache1 as memcache1;
use memcache1::api::Instance;
use memcache1::{Result, Error};
use std::default::Default;
use memcache1::{CloudMemorystoreForMemcached, 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 = CloudMemorystoreForMemcached::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 = Instance::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.projects().locations_instances_create(req, "parent")
.instance_id("magna")
.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")
。
支持上传的方法可以使用最多两种不同的协议:简单和可恢复。每种协议的独特性由定制的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
定制和回调
你可以在最终调用doit()
之前向Method Builder
提供一个代表,以更改调用doit()
方法的方式。相应的方 法将被调用以提供进度信息,以及确定系统是否应该在失败时重试。
delegate trait具有默认实现,这使得你可以以最小的努力对其进行定制。
服务器请求中的可选部分
此库提供的所有结构都是为了通过json进行编码和解码而设计的。选项用于指示部分请求和响应是有效的。大多数选项都是被认为是Parts,它们可以通过名称识别,这些名称将被发送到服务器,以指示请求的设置部分或响应中期望的部分。
构建器参数
使用方法构建器,你能够通过重复调用它的方法来准备一个动作调用。这些方法始终接受一个参数,以下陈述是正确的。
- PODs通过复制传递
- 字符串作为
&str
传递 - request values被移动
参数将被复制或克隆到构建器中,以使其与原始生命周期的独立性。
Cargo功能
utoipa
- 添加对 utoipa 的支持,并自动派生所有类型的utoipa::ToSchema
。您需要在#[openapi(schemas(...))]
中导入和注册所需的类型,否则生成的openapi
规范将无效。
许可证
memcache1 库由 Sebastian Thiel 创建,并置于 MIT 许可之下。您可以在存储库的 许可证文件 中阅读全文。
依赖关系
~12–22MB
~345K SLoC