Struct async_mwmr::KeysOptions

pub struct KeysOptions {
    pub prefetch_size: usize,
    pub reverse: bool,
    pub all_versions: bool,
    pub since_version: u64,
}

Used to set options when iterating over key-value stores.

Fields

prefetch_size: usize

The number of KV pairs to prefetch while iterating.

Some databases optimize iteration by prefetching

reverse: bool

Direction of iteration. False is forward, true is backward.

all_versions: bool

Fetch all valid versions of the same key.

since_version: u64

Only read data that has version > since_version.

Implementations

impl KeysOptions

pub const fn new() -> KeysOptions

Create a new iterator options with default values.

pub fn set_prefetch_size(&mut self, prefetch_size: usize) -> &mut KeysOptions

Set the number of KV pairs to prefetch while iterating.

pub const fn with_prefetch_size(self, prefetch_size: usize) -> KeysOptions

Set the number of KV pairs to prefetch while iterating.

pub fn set_reverse(&mut self, reverse: bool) -> &mut KeysOptions

Set the direction of iteration. False is forward, true is backward.

pub const fn with_reverse(self, reverse: bool) -> KeysOptions

Set the direction of iteration. False is forward, true is backward.

pub fn set_all_versions(&mut self, all_versions: bool) -> &mut KeysOptions

Set whether to fetch all valid versions of the same key.

pub const fn with_all_versions(self, all_versions: bool) -> KeysOptions

Set whether to fetch all valid versions of the same key.

pub fn set_since_version(&mut self, since_version: u64) -> &mut KeysOptions

Set the version to start reading from.

pub const fn with_since_version(self, since_version: u64) -> KeysOptions

Set the version to start reading from.

Trait Implementations

impl Clone for KeysOptions

fn clone(&self) -> KeysOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeysOptions

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

Formats the value using the given formatter.

impl Default for KeysOptions

fn default() -> KeysOptions

Returns the “default value” for a type.

impl Hash for KeysOptions

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeysOptions

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for KeysOptions

impl Eq for KeysOptions

impl StructuralPartialEq for KeysOptions