Struct tikv::storage::mvcc::reader::scanner::ScannerBuilder[][src]

pub struct ScannerBuilder<S: Snapshot>(ScannerConfig<S>);

Implementations

impl<S: Snapshot> ScannerBuilder<S>[src]

pub fn new(snapshot: S, ts: TimeStamp, desc: bool) -> Self[src]

Initialize a new ScannerBuilder

pub fn fill_cache(self, fill_cache: bool) -> Self[src]

Set whether or not read operations should fill the cache.

Defaults to true.

pub fn omit_value(self, omit_value: bool) -> Self[src]

Set whether values of the user key should be omitted. When omit_value is true, the length of returned value will be 0.

Previously this option is called key_only.

Defaults to false.

pub fn isolation_level(self, isolation_level: IsolationLevel) -> Self[src]

Set the isolation level.

Defaults to IsolationLevel::Si.

pub fn range(self, lower_bound: Option<Key>, upper_bound: Option<Key>) -> Self[src]

Limit the range to [lower_bound, upper_bound) in which the ForwardKvScanner should scan. None means unbounded.

Default is (None, None).

pub fn bypass_locks(self, locks: TsSet) -> Self[src]

Set locks that the scanner can bypass. Locks with start_ts in the specified set will be ignored during scanning.

Default is empty.

pub fn hint_min_ts(self, min_ts: Option<TimeStamp>) -> Self[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>) -> Self[src]

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

Default is empty.

pub fn check_has_newer_ts_data(self, enabled: bool) -> Self[src]

Check whether there is data with newer ts. The result of met_newer_ts_data is Unknown if this option is not set.

Default is false.

pub fn build(self) -> Result<Scanner<S>>[src]

Build Scanner from the current configuration.

pub fn build_entry_scanner(
    self,
    after_ts: TimeStamp,
    output_delete: bool
) -> Result<EntryScanner<S>>
[src]

pub fn build_delta_scanner(
    self,
    from_ts: TimeStamp,
    extra_op: ExtraOp
) -> Result<DeltaScanner<S>>
[src]

Auto Trait Implementations

impl<S> RefUnwindSafe for ScannerBuilder<S> where
    S: RefUnwindSafe

impl<S> Send for ScannerBuilder<S>

impl<S> Sync for ScannerBuilder<S>

impl<S> Unpin for ScannerBuilder<S> where
    S: Unpin

impl<S> UnwindSafe for ScannerBuilder<S> where
    S: UnwindSafe

Blanket Implementations

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

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

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

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

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

impl<T> Instrument for T[src]

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

impl<T> Pointable for T[src]

type Init = T

The type for initializers.

impl<T> Pointable for T[src]

type Init = T

The type for initializers.

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<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.

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