Struct fdb::range::Range

source · [−]

pub struct Range { /* private fields */ }

Expand description

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

source

impl Range

source

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.

source

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.

source

pub fn begin_key_ref(&self) -> &Key

Gets a reference to the begin Key of the Range.

source

pub fn end_key_ref(&self) -> &Key

Gets a reference to the end Key of the Range.

source

pub fn into_begin_key(self) -> Key

Extract begin Key from the Range.

source

pub fn into_end_key(self) -> Key

Extract end Key from the Range.

source

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

Extract begin and end Key from the Range.

source

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

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

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

source

pub fn into_mapped_stream<T>(
 self,
 rt: &T,
 mapper: Mapper,
 options: RangeOptions
) -> FdbStreamMappedKeyValue where
 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

source

impl Clone for Range

source

fn clone(&self) -> Range

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Range

source

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

Formats the value using the given formatter. Read more

source

impl PartialEq<Range> for Range

source

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

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

source

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

This method tests for !=.

source

impl StructuralPartialEq for Range

Auto Trait Implementations

impl RefUnwindSafe for Range

impl Send for Range

impl Sync for Range

impl Unpin for Range

impl UnwindSafe for Range

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct fdb::range::Range

Implementations

impl Range

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

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

Panic

pub fn begin_key_ref(&self) -> &Key

pub fn end_key_ref(&self) -> &Key

pub fn into_begin_key(self) -> Key

pub fn into_end_key(self) -> Key

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

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

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

Trait Implementations

impl Clone for Range

fn clone(&self) -> Range

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

impl Debug for Range

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

impl PartialEq<Range> for Range

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

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

impl StructuralPartialEq for Range

Auto Trait Implementations

impl RefUnwindSafe for Range

impl Send for Range

impl Sync for Range

impl Unpin for Range

impl UnwindSafe for Range

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,