Struct fdb::range::RangeOptions

pub struct RangeOptions { /* private fields */ }

RangeOptions specify how a database range operation is carried out.

There are three parameters for which accessors methods are provided.

1. Limit restricts the number of key-value pairs returned as part of a range read. A value of zero indicates no limit.

2. Mode sets the streaming mode of the range read, allowing database to balance latency and bandwidth for this read.

3. Reverse indicates that the read should be performed lexicographic order (when false) or reverse lexicographic (when true).

   When reverse is true and limit is non-zero, last limit key-value pairs in the range are returned. Ranges in reverse is supported natively by the database should have minimal extra cost.

To create a value of RangeOptions type, use Default::default method. The default value represents - no limit, iterator streaming mode and lexicographic order.

Implementations

impl RangeOptions

pub fn set_limit(&mut self, limit: i32)

Set limit

pub fn get_limit(&self) -> i32

Get limit

pub fn set_mode(&mut self, mode: StreamingMode)

Set streaming mode

pub fn get_mode(&self) -> StreamingMode

Get streaming mode

pub fn set_reverse(&mut self, reverse: bool)

Set the read order (lexicographic or non-lexicographic)

pub fn get_reverse(&self) -> bool

Get the read order (lexicographic or non-lexicographic)

Trait Implementations

impl Clone for RangeOptions

fn clone(&self) -> RangeOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RangeOptions

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

Formats the value using the given formatter.

impl Default for RangeOptions

fn default() -> RangeOptions

Returns the “default value” for a type.

impl PartialEq<RangeOptions> for RangeOptions

fn eq(&self, other: &RangeOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RangeOptions