Struct fdb_rl::scan::KeyValueScanLimiter

pub struct KeyValueScanLimiter {
    limiter_mode: LimiterMode,
    limit: usize,
    keyvalues_scanned: Arc<AtomicUsize>,
}

Track the number of keyvalues scanned up to some limit, after which scans should not be allowed.

Fields

limiter_mode: LimiterMode

limit: usize

keyvalues_scanned: Arc<AtomicUsize>

Implementations

impl KeyValueScanLimiter

pub fn enforcing(limit: usize) -> KeyValueScanLimiter

Create a value of KeyValueScanLimiter that enforces a maximum number of keyvalues that can be processed in a single scan.

pub fn tracking() -> KeyValueScanLimiter

Create a value of KeyValueScanLimiter that tracks the number of keyvalues that has been scanned, but does not impose a limit.

pub fn untracked() -> KeyValueScanLimiter

Create a value of KeyValueScanLimiter that neither enforces nor tracks the number of keyvalues scanned.

pub fn get_limit(&self) -> usize

Get the keyvalue scan limit.

pub fn get_scanned_keyvalues(&self) -> usize

Returns the number of keyvalues that have been scanned thus far.

pub(crate) fn try_keyvalue_scan(&self) -> bool

Return true if keyvalue can be read otherwise return false.

Note: When it returns true it also increments keyvalues_scanned field.

Used by LimitManager::try_keyvalue_scan (Linking does not work!).

pub fn is_enforcing(&self) -> bool

Return whether or not this limiter is actually enforcing the limit.

Trait Implementations

impl Clone for KeyValueScanLimiter

fn clone(&self) -> KeyValueScanLimiter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyValueScanLimiter

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

Formats the value using the given formatter.