Struct RangeOption

pub struct RangeOption<'a> {
    pub begin: KeySelector<'a>,
    pub end: KeySelector<'a>,
    pub limit: Option<usize>,
    pub target_bytes: usize,
    pub mode: StreamingMode,
    pub reverse: bool,
    /* private fields */
}

RangeOption represents a query parameters for range scan query.

You can construct RangeOption easily:

use foundationdb::RangeOption;

let opt = RangeOption::from((b"begin".as_ref(), b"end".as_ref()));
let opt: RangeOption = (b"begin".as_ref()..b"end".as_ref()).into();
let opt = RangeOption {
    limit: Some(10),
    ..RangeOption::from((b"begin".as_ref(), b"end".as_ref()))
};

Fields

begin: KeySelector<'a>

The beginning of the range.

end: KeySelector<'a>

The end of the range.

limit: Option<usize>

If non-zero, indicates the maximum number of key-value pairs to return.

target_bytes: usize

If non-zero, indicates a (soft) cap on the combined number of bytes of keys and values to return for each item.

mode: StreamingMode

One of the options::StreamingMode values indicating how the caller would like the data in the range returned.

reverse: bool

If true, key-value pairs will be returned in reverse lexicographical order beginning at the end of the range.

Implementations

impl RangeOption<'_>

pub fn rev(self) -> Self

Reverses the range direction.

pub fn next_range(self, kvs: &FdbValues) -> Option<Self>

Trait Implementations

impl<'a> Clone for RangeOption<'a>

fn clone(&self) -> RangeOption<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RangeOption<'a>

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

Formats the value using the given formatter.

impl Default for RangeOption<'_>

fn default() -> Self

Returns the “default value” for a type.

impl From<&Subspace> for RangeOption<'static>

fn from(subspace: &Subspace) -> Self

Converts to this type from the input type.

impl<'a> From<(&'a [u8], &'a [u8])> for RangeOption<'a>

fn from((begin, end): (&'a [u8], &'a [u8])) -> Self

Converts to this type from the input type.

impl<'a> From<(KeySelector<'a>, KeySelector<'a>)> for RangeOption<'a>

fn from((begin, end): (KeySelector<'a>, KeySelector<'a>)) -> Self

Converts to this type from the input type.

impl From<(Vec<u8>, Vec<u8>)> for RangeOption<'static>

fn from((begin, end): (Vec<u8>, Vec<u8>)) -> Self

Converts to this type from the input type.

impl<'a> From<Range<&'a [u8]>> for RangeOption<'a>

fn from(range: Range<&'a [u8]>) -> Self

Converts to this type from the input type.

impl<'a> From<Range<KeySelector<'a>>> for RangeOption<'a>

fn from(range: Range<KeySelector<'a>>) -> Self

Converts to this type from the input type.

impl From<Range<Vec<u8>>> for RangeOption<'static>

fn from(range: Range<Vec<u8>>) -> Self

Converts to this type from the input type.

impl<'a> From<RangeInclusive<&'a [u8]>> for RangeOption<'a>

fn from(range: RangeInclusive<&'a [u8]>) -> Self

Converts to this type from the input type.

impl From<RangeInclusive<Vec<u8>>> for RangeOption<'static>

fn from(range: RangeInclusive<Vec<u8>>) -> Self

Converts to this type from the input type.