Struct fdb::range::Range

pub struct Range { /* private fields */ }

Range describes an exact range of keyspace, specified by a begin and end key.

As with all FDB APIs, begin is inclusive, and end exclusive.

Implementations

impl Range

pub fn new(begin: impl Into<Key>, end: impl Into<Key>) -> Range

Construct a new Range with an inclusive begin key an exclusive end key.

pub fn starts_with(prefix_key: impl Into<Key>) -> Range

Return a Range that describes all possible keys that are prefixed with the specified key.

Panic

Panics if the supplied Key is empty or contains only 0xFF bytes.

pub fn begin_key_ref(&self) -> &Key

Gets a reference to the begin Key of the Range.

pub fn end_key_ref(&self) -> &Key

Gets a reference to the end Key of the Range.

pub fn into_begin_key(self) -> Key

Extract begin Key from the Range.

pub fn into_end_key(self) -> Key

Extract end Key from the Range.

pub fn into_parts(self) -> (Key, Key)

Extract begin and end Key from the Range.

pub fn into_stream<T>(self, rt: &T, options: RangeOptions) -> FdbStreamKeyValuewhere T: ReadTransaction,

Gets an ordered range of keys and values from the database.

The returned FdbStreamKeyValue implements Stream trait that yields a KeyValue item.

pub fn into_mapped_stream<T>( self, rt: &T, mapper: Mapper, options: RangeOptions ) -> FdbStreamMappedKeyValuewhere T: ReadTransaction,

Gets an ordered range of mapped keys and values from the database.

The returned FdbStreamMappedKeyValue implements Stream trait that yields a MappedKeyValue item.

Trait Implementations

impl Clone for Range

fn clone(&self) -> Range

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Range

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

Formats the value using the given formatter.

impl PartialEq<Range> for Range

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