Struct fdb_rl::scan::ScanPropertiesBuilder

pub struct ScanPropertiesBuilder {
    range_options: RangeOptions,
    scan_limiter: ScanLimiter,
}

Build ScanProperties with custom RangeOptions and ScanLimiter.

Methods can be chained. Value of ScanProperties is constructed by calling build method.

Fields

range_options: RangeOptions

scan_limiter: ScanLimiter

Implementations

impl ScanPropertiesBuilder

pub fn new() -> ScanPropertiesBuilder

Returns a new builder.

pub unsafe fn set_range_options<F>( &mut self, f: F ) -> &mut ScanPropertiesBuilderwhere F: FnOnce(&mut RangeOptions),

Set RangeOptions using a closure.

Safety

There is no way in the RangeOptions API to set a limit of 0. Infact if you set the limit to 0, you are indicating that you want unlimited rows, which almost always is not the behavior that you want.

pub fn set_scan_limiter( &mut self, scan_limiter: ScanLimiter ) -> &mut ScanPropertiesBuilder

Set ScanLimiter.

pub fn build(self) -> ScanProperties

Create the configured ScanProperties.

Trait Implementations

impl Debug for ScanPropertiesBuilder

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

Formats the value using the given formatter.

impl Default for ScanPropertiesBuilder

fn default() -> ScanPropertiesBuilder

Returns the “default value” for a type.