Struct fdb_rl::range::TupleRange

pub struct TupleRange {
    low_endpoint: TupleLowEndpoint,
    high_endpoint: TupleHighEndpoint,
}

A range within an optional subspace specified by two Tuple endpoints.

A TupleRange can be converted into a KeyRange.

Fields

low_endpoint: TupleLowEndpoint

high_endpoint: TupleHighEndpoint

Implementations

impl TupleRange

pub fn new( low_endpoint: TupleLowEndpoint, high_endpoint: TupleHighEndpoint ) -> TupleRange

Create a TupleRange

pub fn all() -> TupleRange

Create a TupleRange of all the tuples.

pub fn all_of(prefix: &Tuple) -> TupleRange

Create a TupleRange over all keys beginning with a given Tuple.

This is a shortcut for creating a TupleRange with prefix as both the low-endpoint and high-endpoint and setting the type to range inclusive.

pub fn between(low: &Option<Tuple>, high: &Option<Tuple>) -> TupleRange

Create a TupleRange over all keys between the given Tuples.

low is the inclusive start of the range. None indicates the beginning.

high is the exclusive end of the range. None indicates the end.

pub fn prepend(self, beginning: &Tuple) -> TupleRange

Create a TupleRange over the same keys as this range but prepended by the supplied Tuple.

For example, if this range is over all Tuple’s from ("a", 3,) exclusive to ("b", 4,) inclusive, and one calls this method with (0, null) as the argument, this will create a range from (0, null, "a", 3,) exclusive to (0, null, "b", 4,) inclusive.

pub fn into_key_range(self, maybe_subspace: &Option<Subspace>) -> KeyRange

Convert to a KeyRange.

Takes an optional Subspace that the key range should be prefixed by.

Trait Implementations

impl Clone for TupleRange

fn clone(&self) -> TupleRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TupleRange

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

Formats the value using the given formatter.

impl PartialEq<TupleRange> for TupleRange

fn eq(&self, other: &TupleRange) -> 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 TupleRange