Struct DeleteRangeRequest 

pub struct DeleteRangeRequest {
    pub key: Vec<u8>,
    pub range_end: Vec<u8>,
    pub prev_kv: bool,
}

Fields

key: Vec<u8>

key is the first key to delete in the range.

range_end: Vec<u8>

range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is ‘\0’, the range is all keys greater than or equal to the key argument.

prev_kv: bool

If prev_kv is set, gets the previous key-value pairs before deleting it. The previous key-value pairs will be returned in the delete response.

Implementations

impl DeleteRangeRequest

pub fn new() -> Self

pub fn range(&self) -> (Bound<Vec<u8>>, Bound<Vec<u8>>)

Returns the RangeBounds.

pub fn with_key(self, key: impl Into<Vec<u8>>) -> Self

key is the first key to delete in the range. If range_end is not given, the range is defined to contain only the key argument.

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

key is the first key to delete in the range.

range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is ‘\0’, the range is all keys greater than or equal to the key argument.

pub fn with_prefix(self, key: impl Into<Vec<u8>>) -> Self

Deletes all keys prefixed with key. range_end is one bit larger than the given key.

pub fn with_prev_kv(self) -> Self

If prev_kv is set, gets the previous key-value pairs before deleting it. The previous key-value pairs will be returned in the delete response.

Trait Implementations

impl Clone for DeleteRangeRequest

fn clone(&self) -> DeleteRangeRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteRangeRequest

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

Formats the value using the given formatter.

impl Default for DeleteRangeRequest

fn default() -> DeleteRangeRequest

Returns the “default value” for a type.

impl From<DeleteRangeRequest> for DeleteRangeRequest

fn from(req: DeleteRangeRequest) -> Self

Converts to this type from the input type.

impl From<DeleteRangeRequest> for DeleteRangeRequest

fn from(value: PbDeleteRangeRequest) -> Self

Converts to this type from the input type.

impl TryFrom<DeleteRangeRequest> for Delete

type Error = Error

The type returned in the event of a conversion error.

fn try_from(req: DeleteRangeRequest) -> Result<Self>

Performs the conversion.