Struct etcd_client::GetOptions

pub struct GetOptions { /* private fields */ }

Options for Get operation.

Implementations

impl GetOptions

pub const fn new() -> Self

Creates a GetOptions.

pub fn with_range(self, end_key: impl Into<Vec<u8>>) -> Self

Specifies the range of ‘Get’. Returns the keys in the range [key, end_key). end_key must be lexicographically greater than start key.

pub fn with_from_key(self) -> Self

Gets all keys >= key.

pub fn with_prefix(self) -> Self

Gets all keys prefixed with key.

pub fn with_all_keys(self) -> Self

Gets all keys.

pub const fn with_limit(self, limit: i64) -> Self

Limits the number of keys returned for the request. When limit is set to 0, it is treated as no limit.

pub const fn with_revision(self, revision: i64) -> Self

The point-in-time of the key-value store to use for the range. If revision is less or equal to zero, the range is over the newest key-value store. If the revision has been compacted, ErrCompacted is returned as a response.

pub fn with_sort(self, target: SortTarget, order: SortOrder) -> Self

Sets the order for returned sorted results. It requires ‘with_range’ and/or ‘with_prefix’ to be specified too.

pub const fn with_serializable(self) -> Self

Sets the get request to use serializable member-local reads. Get requests are linearizable by default; linearizable requests have higher latency and lower throughput than serializable requests but reflect the current consensus of the cluster. For better performance, in exchange for possible stale reads, a serializable get request is served locally without needing to reach consensus with other nodes in the cluster.

pub const fn with_keys_only(self) -> Self

Returns only the keys and not the values.

pub const fn with_count_only(self) -> Self

Returns only the count of the keys in the range.

pub const fn with_min_mod_revision(self, revision: i64) -> Self

Sets the lower bound for returned key mod revisions; all keys with lesser mod revisions will be filtered away.

pub const fn with_max_mod_revision(self, revision: i64) -> Self

Sets the upper bound for returned key mod revisions; all keys with greater mod revisions will be filtered away.

pub const fn with_min_create_revision(self, revision: i64) -> Self

Sets the lower bound for returned key create revisions; all keys with lesser create revisions will be filtered away.

pub const fn with_max_create_revision(self, revision: i64) -> Self

max_create_revision is the upper bound for returned key create revisions; all keys with greater create revisions will be filtered away.

Trait Implementations

impl Clone for GetOptions

fn clone(&self) -> GetOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetOptions

fn default() -> GetOptions

Returns the “default value” for a type.