Struct tikv::storage::kv::CursorBuilder[−][src]

pub struct CursorBuilder<'a, S> where
    S: Snapshot,  {
    snapshot: &'a S,
    cf: &'static str,
    scan_mode: ScanMode,
    fill_cache: bool,
    prefix_seek: bool,
    upper_bound: Option<Key>,
    lower_bound: Option<Key>,
    hint_min_ts: Option<TimeStamp>,
    hint_max_ts: Option<TimeStamp>,
    key_only: bool,
    max_skippable_internal_keys: u64,
}

A handy utility to build a snapshot cursor according to various configurations.

Fields

snapshot: &'a Scf: &'static strscan_mode: ScanModefill_cache: boolprefix_seek: boolupper_bound: Option<Key>lower_bound: Option<Key>hint_min_ts: Option<TimeStamp>hint_max_ts: Option<TimeStamp>key_only: boolmax_skippable_internal_keys: u64

Implementations

`impl<'a, S> CursorBuilder<'a, S> where S: 'a + Snapshot,` [src]

`pub fn new(snapshot: &'a S, cf: &'static str) -> CursorBuilder<'a, S>`[src]

Initialize a new CursorBuilder.

`pub fn fill_cache(self, fill_cache: bool) -> CursorBuilder<'a, S>`[src]

Set whether or not read operations should fill the cache.

Defaults to true.

`pub fn prefix_seek(self, prefix_seek: bool) -> CursorBuilder<'a, S>`[src]

Set whether or not to use prefix seek.

Defaults to false, it means use total order seek.

`pub fn scan_mode(self, scan_mode: ScanMode) -> CursorBuilder<'a, S>`[src]

Set iterator scanning mode.

Defaults to ScanMode::Forward.

`pub fn range( self, lower: Option<Key>, upper: Option<Key> ) -> CursorBuilder<'a, S>`[src]

Set iterator range by giving lower and upper bound. The range is left closed right open.

Both default to None.

`pub fn hint_min_ts(self, min_ts: Option<TimeStamp>) -> CursorBuilder<'a, S>`[src]

Set the hint for the minimum commit ts we want to scan.

Default is empty.

`pub fn hint_max_ts(self, max_ts: Option<TimeStamp>) -> CursorBuilder<'a, S>`[src]

Set the hint for the maximum commit ts we want to scan.

Default is empty.

`pub fn key_only(self, key_only: bool) -> CursorBuilder<'a, S>`[src]

`pub fn max_skippable_internal_keys(self, count: u64) -> CursorBuilder<'a, S>`[src]

`pub fn build(self) -> Result<Cursor<<S as Snapshot>::Iter>, Error>`[src]

Build Cursor from the current configuration.

Auto Trait Implementations

`impl<'a, S> RefUnwindSafe for CursorBuilder<'a, S> where S: RefUnwindSafe,`

`impl<'a, S> Send for CursorBuilder<'a, S>`

`impl<'a, S> Sync for CursorBuilder<'a, S>`

`impl<'a, S> Unpin for CursorBuilder<'a, S>`

`impl<'a, S> UnwindSafe for CursorBuilder<'a, S> where S: RefUnwindSafe,`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<V, W> ConvertFrom<W> for V where W: ConvertTo<V>,` [src]

`pub fn convert_from(ctx: &mut EvalContext, from: W) -> Result<V, Error>`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T> Instrument for T`[src]

`pub fn instrument(self, span: Span) -> Instrumented<Self>`[src]

`pub fn in_current_span(self) -> Instrumented<Self>`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> Pointable for T`[src]

`pub const ALIGN: usize`[src]

`type Init = T`

The type for initializers.

`pub unsafe fn init(init: <T as Pointable>::Init) -> usize`[src]

`pub unsafe fn deref<'a>(ptr: usize) -> &'a T`[src]

`pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T`[src]

`pub unsafe fn drop(ptr: usize)`[src]

`impl<T> Pointable for T`[src]

`pub const ALIGN: usize`[src]

`type Init = T`

The type for initializers.

`pub unsafe fn init(init: <T as Pointable>::Init) -> usize`[src]

`pub unsafe fn deref<'a>(ptr: usize) -> &'a T`[src]

`pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T`[src]

`pub unsafe fn drop(ptr: usize)`[src]

`impl<T> Same<T> for T`[src]

`type Output = T`

Should always be Self

`impl<T> Sealed<T> for T where T: ?Sized,` [src]

`impl<T> SendSyncUnwindSafe for T where T: Send + Sync + UnwindSafe + ?Sized,` [src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

Struct tikv::storage::kv::CursorBuilder⎘[−][src]

Fields

Implementations

impl<'a, S> CursorBuilder<'a, S> where S: 'a + Snapshot, [src]

pub fn new(snapshot: &'a S, cf: &'static str) -> CursorBuilder<'a, S>[src]

pub fn fill_cache(self, fill_cache: bool) -> CursorBuilder<'a, S>[src]

pub fn prefix_seek(self, prefix_seek: bool) -> CursorBuilder<'a, S>[src]

pub fn scan_mode(self, scan_mode: ScanMode) -> CursorBuilder<'a, S>[src]

pub fn range( self, lower: Option<Key>, upper: Option<Key>) -> CursorBuilder<'a, S>[src]

pub fn hint_min_ts(self, min_ts: Option<TimeStamp>) -> CursorBuilder<'a, S>[src]

pub fn hint_max_ts(self, max_ts: Option<TimeStamp>) -> CursorBuilder<'a, S>[src]

pub fn key_only(self, key_only: bool) -> CursorBuilder<'a, S>[src]

pub fn max_skippable_internal_keys(self, count: u64) -> CursorBuilder<'a, S>[src]

pub fn build(self) -> Result<Cursor<<S as Snapshot>::Iter>, Error>[src]

Auto Trait Implementations

impl<'a, S> RefUnwindSafe for CursorBuilder<'a, S> where S: RefUnwindSafe,

impl<'a, S> Send for CursorBuilder<'a, S>

impl<'a, S> Sync for CursorBuilder<'a, S>

impl<'a, S> Unpin for CursorBuilder<'a, S>

impl<'a, S> UnwindSafe for CursorBuilder<'a, S> where S: RefUnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

impl<V, W> ConvertFrom<W> for V where W: ConvertTo<V>, [src]

pub fn convert_from(ctx: &mut EvalContext, from: W) -> Result<V, Error>[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

impl<T> Instrument for T[src]

pub fn instrument(self, span: Span) -> Instrumented<Self>[src]

pub fn in_current_span(self) -> Instrumented<Self>[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

pub fn into(self) -> U[src]

impl<T> Pointable for T[src]

pub const ALIGN: usize[src]

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize[src]

pub unsafe fn deref<'a>(ptr: usize) -> &'a T[src]

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T[src]

pub unsafe fn drop(ptr: usize)[src]

impl<T> Pointable for T[src]

pub const ALIGN: usize[src]

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize[src]

pub unsafe fn deref<'a>(ptr: usize) -> &'a T[src]

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T[src]

pub unsafe fn drop(ptr: usize)[src]

impl<T> Same<T> for T[src]

type Output = T

impl<T> Sealed<T> for T where T: ?Sized, [src]

impl<T> SendSyncUnwindSafe for T where T: Send + Sync + UnwindSafe + ?Sized, [src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<V, T> VZip<V> for T where V: MultiLane<T>, [src]

pub fn vzip(self) -> V[src]

Struct tikv::storage::kv::CursorBuilder[−][src]

`impl<'a, S> CursorBuilder<'a, S> where S: 'a + Snapshot,` [src]

`pub fn new(snapshot: &'a S, cf: &'static str) -> CursorBuilder<'a, S>`[src]

`pub fn fill_cache(self, fill_cache: bool) -> CursorBuilder<'a, S>`[src]

`pub fn prefix_seek(self, prefix_seek: bool) -> CursorBuilder<'a, S>`[src]

`pub fn scan_mode(self, scan_mode: ScanMode) -> CursorBuilder<'a, S>`[src]

`pub fn range( self, lower: Option<Key>, upper: Option<Key> ) -> CursorBuilder<'a, S>`[src]

`pub fn hint_min_ts(self, min_ts: Option<TimeStamp>) -> CursorBuilder<'a, S>`[src]

`pub fn hint_max_ts(self, max_ts: Option<TimeStamp>) -> CursorBuilder<'a, S>`[src]

`pub fn key_only(self, key_only: bool) -> CursorBuilder<'a, S>`[src]

`pub fn max_skippable_internal_keys(self, count: u64) -> CursorBuilder<'a, S>`[src]

`pub fn build(self) -> Result<Cursor<<S as Snapshot>::Iter>, Error>`[src]

`impl<'a, S> RefUnwindSafe for CursorBuilder<'a, S> where S: RefUnwindSafe,`

`impl<'a, S> Send for CursorBuilder<'a, S>`

`impl<'a, S> Sync for CursorBuilder<'a, S>`

`impl<'a, S> Unpin for CursorBuilder<'a, S>`

`impl<'a, S> UnwindSafe for CursorBuilder<'a, S> where S: RefUnwindSafe,`

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<V, W> ConvertFrom<W> for V where W: ConvertTo<V>,` [src]

`pub fn convert_from(ctx: &mut EvalContext, from: W) -> Result<V, Error>`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T> Instrument for T`[src]

`pub fn instrument(self, span: Span) -> Instrumented<Self>`[src]

`pub fn in_current_span(self) -> Instrumented<Self>`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> Pointable for T`[src]

`pub const ALIGN: usize`[src]

`type Init = T`

`pub unsafe fn init(init: <T as Pointable>::Init) -> usize`[src]

`pub unsafe fn deref<'a>(ptr: usize) -> &'a T`[src]

`pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T`[src]

`pub unsafe fn drop(ptr: usize)`[src]

`impl<T> Pointable for T`[src]

`pub const ALIGN: usize`[src]

`type Init = T`

`pub unsafe fn init(init: <T as Pointable>::Init) -> usize`[src]

`pub unsafe fn deref<'a>(ptr: usize) -> &'a T`[src]

`pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T`[src]

`pub unsafe fn drop(ptr: usize)`[src]

`impl<T> Same<T> for T`[src]

`type Output = T`

`impl<T> Sealed<T> for T where T: ?Sized,` [src]

`impl<T> SendSyncUnwindSafe for T where T: Send + Sync + UnwindSafe + ?Sized,` [src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

`impl<V, T> VZip<V> for T where V: MultiLane<T>,` [src]

`pub fn vzip(self) -> V`[src]