Struct tikv::storage::Cursor

[+] Show declaration

pub struct Cursor<I> where
    I: Iterator,  {
    iter: I,
    scan_mode: ScanMode,
    prefix_seek: bool,
    min_key: Option<Vec<u8, Global>>,
    max_key: Option<Vec<u8, Global>>,
    cur_key_has_read: Cell<bool>,
    cur_value_has_read: Cell<bool>,
}

Fields

iter: I

scan_mode: ScanMode

prefix_seek: bool

min_key: Option<Vec<u8, Global>>

max_key: Option<Vec<u8, Global>>

cur_key_has_read: Cell<bool>

cur_value_has_read: Cell<bool>

Implementations

impl<I> Cursor<I> where
    I: Iterator, [−]

pub fn new(iter: I, mode: ScanMode, prefix_seek: bool) -> Cursor<I>

pub fn seek(
    &mut self,
    key: &Key,
    statistics: &mut CfStatistics
) -> Result<bool, Error>

pub fn near_seek(
    &mut self,
    key: &Key,
    statistics: &mut CfStatistics
) -> Result<bool, Error>[−]

Seek the specified key.

This method assume the current position of cursor is around key, otherwise you should use seek instead.

pub fn get(
    &mut self,
    key: &Key,
    statistics: &mut CfStatistics
) -> Result<Option<&[u8]>, Error>[−]

Get the value of specified key.

This method assume the current position of cursor is around key, otherwise you should seek first.

pub fn seek_for_prev(
    &mut self,
    key: &Key,
    statistics: &mut CfStatistics
) -> Result<bool, Error>

pub fn near_seek_for_prev(
    &mut self,
    key: &Key,
    statistics: &mut CfStatistics
) -> Result<bool, Error>[−]

Find the largest key that is not greater than the specific key.

pub fn reverse_seek(
    &mut self,
    key: &Key,
    statistics: &mut CfStatistics
) -> Result<bool, Error>

pub fn near_reverse_seek(
    &mut self,
    key: &Key,
    statistics: &mut CfStatistics
) -> Result<bool, Error>[−]

Reverse seek the specified key.

This method assume the current position of cursor is around key, otherwise you should use reverse_seek instead.

pub fn key(&self, statistics: &mut CfStatistics) -> &[u8]

pub fn value(&self, statistics: &mut CfStatistics) -> &[u8]

pub fn seek_to_first(&mut self, statistics: &mut CfStatistics) -> bool

pub fn seek_to_last(&mut self, statistics: &mut CfStatistics) -> bool

pub fn internal_seek(
    &mut self,
    key: &Key,
    statistics: &mut CfStatistics
) -> Result<bool, Error>

pub fn internal_seek_for_prev(
    &mut self,
    key: &Key,
    statistics: &mut CfStatistics
) -> Result<bool, Error>

pub fn next(&mut self, statistics: &mut CfStatistics) -> bool

pub fn prev(&mut self, statistics: &mut CfStatistics) -> bool

pub fn valid(&self) -> Result<bool, Error>