Struct async_mwmr::IteratorOptions

pub struct IteratorOptions {
    pub prefetch_size: usize,
    pub prefetch_values: bool,
    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

prefetch_values: bool

Indicates whether we should prefetch values during iteration and store them.

Some databases use key-value separation for optimization and this option can be used to prefetch values.

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 IteratorOptions

pub const fn new() -> IteratorOptions

Create a new iterator options with default values.

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

Set the number of KV pairs to prefetch while iterating.

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

Set the number of KV pairs to prefetch while iterating.

pub fn set_prefetch_values( &mut self, prefetch_values: bool ) -> &mut IteratorOptions

Set whether we should prefetch values during iteration and store them.

pub const fn with_prefetch_values( self, prefetch_values: bool ) -> IteratorOptions

Set whether we should prefetch values during iteration and store them.

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

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

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

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

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

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

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

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

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

Set the version to start reading from.

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

Set the version to start reading from.

Trait Implementations

impl Clone for IteratorOptions

fn clone(&self) -> IteratorOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IteratorOptions

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

Formats the value using the given formatter.

impl Default for IteratorOptions

fn default() -> IteratorOptions

Returns the “default value” for a type.

impl Hash for IteratorOptions

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 IteratorOptions

fn eq(&self, other: &IteratorOptions) -> 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 IteratorOptions

impl Eq for IteratorOptions

impl StructuralPartialEq for IteratorOptions