Module etcd::kv [] [src]

etcd's key-value API.

The term "node" in the documentation for this module refers to a key-value pair or a directory of key-value pairs. For example, "/foo" is a key if it has a value, but it is a directory if there other other key-value pairs "underneath" it, such as "/foo/bar".

Structs

GetOptions

Options for customizing the behavior of kv::get.

KeyValueInfo

Information about the result of a successful key-value API operation.

Node

An etcd key or directory.

WatchOptions

Options for customizing the behavior of kv::watch.

Enums

Action

The type of action that was taken in response to a key value API request.

WatchError

An error returned by kv::watch.

Functions

compare_and_delete

Deletes a node only if the given current value and/or current modified index match.

compare_and_swap

Updates a node only if the given current value and/or current modified index match.

create

Creates a new key-value pair.

create_dir

Creates a new empty directory.

create_in_order

Creates a new key-value pair in a directory with a numeric key name larger than any of its sibling key-value pairs.

delete

Deletes a node.

delete_dir

Deletes an empty directory or a key-value pair at the given key.

get

Gets the value of a node.

set

Sets the value of a key-value pair.

set_dir

Sets the key to an empty directory.

update

Updates an existing key-value pair.

update_dir

Updates a directory.

watch

Watches a node for changes and returns the new value as soon as a change takes place.

Type Definitions

FutureKeyValueInfo

The future returned by most key-value API calls.