Struct aerospike::ScanPolicy

pub struct ScanPolicy {
    pub base_policy: BasePolicy,
    pub scan_percent: u8,
    pub max_concurrent_nodes: usize,
    pub record_queue_size: usize,
    pub include_bin_data: bool,
    pub fail_on_cluster_change: bool,
}

ScanPolicy encapsulates optional parameters used in scan operations.

Fields

base_policy: BasePolicy

Base policy instance

scan_percent: u8

Percent of data to scan. Valid integer range is 1 to 100. Default is 100.

max_concurrent_nodes: usize

Maximum number of concurrent requests to server nodes at any point in time. If there are 16 nodes in the cluster and max_concurrent_nodes is 8, then scan requests will be made to 8 nodes in parallel. When a scan completes, a new scan request will be issued until all 16 nodes have been scanned. Default (0) is to issue requests to all server nodes in parallel.

record_queue_size: usize

Number of records to place in queue before blocking. Records received from multiple server nodes will be placed in a queue. A separate thread consumes these records in parallel. If the queue is full, the producer threads will block until records are consumed.

include_bin_data: bool

Indicates if bin data is retrieved. If false, only record digests are retrieved.

fail_on_cluster_change: bool

Terminate scan if cluster is in fluctuating state.

Methods

impl ScanPolicy

fn new() -> Self

Create a new scan policy instance with default parameters.

Trait Implementations

impl Debug for ScanPolicy

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for ScanPolicy

fn clone(&self) -> ScanPolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ScanPolicy

fn default() -> ScanPolicy

Returns the "default value" for a type.