Struct etcd_client::GetOptions

source · [−]

pub struct GetOptions { /* private fields */ }

Expand description

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for GetOptions

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

Formats the value using the given formatter. Read more

impl Default for GetOptions

fn default() -> GetOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for GetOptions

impl Send for GetOptions

impl Sync for GetOptions

impl Unpin for GetOptions

impl UnwindSafe for GetOptions

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more