Struct etcdv3client::pb::RangeRequest

pub struct RangeRequest {
    pub key: Vec<u8>,
    pub range_end: Vec<u8>,
    pub limit: i64,
    pub revision: i64,
    pub sort_order: i32,
    pub sort_target: i32,
    pub serializable: bool,
    pub keys_only: bool,
    pub count_only: bool,
    pub min_mod_revision: i64,
    pub max_mod_revision: i64,
    pub min_create_revision: i64,
    pub max_create_revision: i64,
}

Fields

key: Vec<u8>

key is the first key for the range. If range_end is not given, the request only looks up key.

range_end: Vec<u8>

range_end is the upper bound on the requested range [key, range_end). If range_end is '\0', the range is all keys >= key. If range_end is key plus one (e.g., "aa"+1 == "ab", "a\xff"+1 == "b"), then the range request gets all keys prefixed with key. If both key and range_end are '\0', then the range request returns all keys.

limit: i64

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

revision: i64

revision is 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.

sort_order: i32

sort_order is the order for returned sorted results.

sort_target: i32

sort_target is the key-value field to use for sorting.

serializable: bool

serializable sets the range request to use serializable member-local reads. Range 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 range request is served locally without needing to reach consensus with other nodes in the cluster.

keys_only: bool

keys_only when set returns only the keys and not the values.

count_only: bool

count_only when set returns only the count of the keys in the range.

min_mod_revision: i64

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

max_mod_revision: i64

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

min_create_revision: i64

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

max_create_revision: i64

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

Methods

impl RangeRequest

pub fn sort_order(&self) -> SortOrder

pub fn set_sort_order(&mut self, value: SortOrder)

pub fn sort_target(&self) -> SortTarget

pub fn set_sort_target(&mut self, value: SortTarget)

Trait Implementations

impl Clone for RangeRequest

fn clone(&self) -> RangeRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RangeRequest

fn default() -> RangeRequest

Returns the "default value" for a type.

impl PartialEq<RangeRequest> for RangeRequest

fn eq(&self, other: &RangeRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RangeRequest) -> bool

This method tests for !=.

impl Debug for RangeRequest

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

Formats the value using the given formatter.

impl StructuralPartialEq for RangeRequest

impl Message for RangeRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(&mut self, buf: &mut B) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: IntoBuf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: IntoBuf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: IntoBuf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: IntoBuf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.