Crate etcd_client[−][src]
An etcd v3 API client for Rust. It provides asynchronous client backed by tokio and tonic.
Supported APIs
- KV
- Watch
- Lease
- Auth
- Maintenance
- Cluster
- Lock
- Election
Usage
Add this to your Cargo.toml
:
[dependencies]
etcd-client = "0.6"
tokio = { version = "1.0", features = ["full"] }
To get started using etcd-client
:
use etcd_client::{Client, Error};
#[tokio::main]
async fn main() -> Result<(), Error> {
let mut client = Client::connect(["localhost:2379"], None).await?;
// put kv
client.put("foo", "bar", None).await?;
// get kv
let resp = client.get("foo", None).await?;
if let Some(kv) = resp.kvs().first() {
println!("Get kv: {{{}: {}}}", kv.key_str()?, kv.value_str()?);
}
Ok(())
}
Examples
Examples can be found in etcd-client/examples
.
Feature Flags
tls
: Enables therustls
-based TLS connection. Not enabled by default.tls-roots
: Adds system trust roots torustls
-based TLS connection using therustls-native-certs
crate. Not enabled by default.
Structs
AlarmMember | Alarm member of respond. |
AlarmOptions | Options for |
AlarmResponse | Response for |
AuthClient | Client for Auth operations. |
AuthDisableResponse | Response for |
AuthEnableResponse | Response for |
CampaignResponse | Response for |
Certificate | tls Represents a X509 certificate. |
Client | Asynchronous |
ClusterClient | Client for Cluster operations. |
CompactionOptions | Options for |
CompactionResponse | Response for |
Compare | Transaction comparision. |
ConnectOptions | Options for |
DefragmentResponse | Response for |
DeleteOptions | Options for |
DeleteResponse | Response for |
ElectionClient | Client for Elect operations. |
Event | Watching event. |
GetOptions | Options for |
GetResponse | Response for |
HashKvResponse | Response for |
HashResponse | Response for |
Identity | tls Represents a private key and X509 certificate. |
KeyValue | Key-value pair. |
KvClient | Client for KV operations. |
LeaderKey | Leader key of election |
LeaderResponse | Response for |
LeaseClient | Client for lease operations. |
LeaseGrantOptions | Options for |
LeaseGrantResponse | Response for |
LeaseKeepAliveResponse | Response for |
LeaseKeepAliveStream | The lease keep alive response stream. |
LeaseKeeper | The lease keep alive handle. |
LeaseLeasesResponse | Response for |
LeaseRevokeResponse | Response for |
LeaseStatus | Lease status. |
LeaseTimeToLiveOptions | Options for |
LeaseTimeToLiveResponse | Response for |
LockClient | Client for Lock operations. |
LockOptions | Options for |
LockResponse | Response for |
MaintenanceClient | Client for maintenance operations. |
Member | Cluster member. |
MemberAddOptions | Options for |
MemberAddResponse | Response for |
MemberListResponse | Response for |
MemberPromoteResponse | Response for |
MemberRemoveResponse | Response for |
MemberUpdateResponse | Response for |
MoveLeaderResponse | Response for |
ObserveStream | Response for |
Permission | Role access permission. |
ProclaimOptions | Options for |
ProclaimResponse | Response for |
PutOptions | Options for |
PutResponse | Response for |
ResignOptions | Options for |
ResignResponse | Response for |
ResponseHeader | General |
RoleAddResponse | Response for role add operation. |
RoleDeleteResponse | Response for delete role operation. |
RoleGetResponse | Response for get role operation. |
RoleGrantPermissionResponse | Response for grant role permission operation. |
RoleListResponse | Response for list role operation. |
RoleRevokePermissionOptions | Options for grant role permission operation. |
RoleRevokePermissionResponse | Response for revoke role permission operation. |
SnapshotResponse | Response for |
SnapshotStreaming | Response for |
StatusResponse | Response for |
TlsOptions | tls Configures TLS settings for endpoints. |
Txn | Transaction of multiple operations. |
TxnOp | Transaction operation. |
TxnResponse | Response for |
UnlockResponse | Response for |
UserAddOptions | Options for |
UserAddResponse | Response for use add operation. |
UserChangePasswordResponse | Response for change user’s password operation. |
UserDeleteResponse | Response for delete user operation. |
UserGetResponse | Response for get user operation. |
UserGrantRoleResponse | Response for grant role for an user operation. |
UserListResponse | Response for list user operation. |
UserRevokeRoleResponse | Response for revoke role for an user operation. |
WatchClient | Client for watch operations. |
WatchOptions | Options for |
WatchResponse | Response for |
WatchStream | The watch response stream. |
Watcher | The watching handle. |
Enums
AlarmAction | Alarm action. |
AlarmType | Alarm type. |
CompareOp | Logical comparison operation. |
Error | The error type for |
EventType | The kind of event. |
PermissionType | |
SortOrder | The ordering for sorted requests. |
SortTarget | The key-value field to sort. |
TxnOpResponse | Transaction operation response. |
WatchFilterType | Watch filter type. |