Struct fdb::subspace::Subspace

pub struct Subspace { /* private fields */ }

Subspace provides a convenient way to use Tuple to define namespaces for different categories of data.

Implementations

impl Subspace

pub fn new(prefix_bytes: Bytes) -> Subspace

Create a new Subspace with prefix [Bytes] and an empty prefix Tuple.

pub fn subspace(&self, tuple: &Tuple) -> Subspace

Gets a new subspace which is equivalent of this subspace with its prefix Tuple extended by the specified Tuple.

pub fn contains(&self, key: &Bytes) -> bool

Tests whether the specified key starts with this Subspace’s prefix, indicating that the Subspace. logically contains key.

pub fn pack(&self) -> Bytes

Get the key encoding prefix used for this Subspace.

pub fn pack_with_versionstamp(&self, tuple: &Tuple) -> FdbResult<Bytes>

Get the key encoding of the specified Tuple in this Subspace for use with SetVersionstampedKey.

Panic

The index where incomplete versionstamp is located is a 32-bit little-endian integer. If the generated index overflows u32, then this function panics.

pub fn range(&self, tuple: &Tuple) -> Range

Gets a Range representing all keys in the Subspace strictly starting with the specified Tuple.

Panic

Panics if the tuple or subspace contains an incomplete Versionstamp.

pub fn unpack(&self, key: &Bytes) -> FdbResult<Tuple>

Gets the Tuple encoded by the given key, with this Subspace’s prefix removed.

Trait Implementations

impl Clone for Subspace

fn clone(&self) -> Subspace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Subspace

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

Formats the value using the given formatter.

impl Ord for Subspace

fn cmp(&self, other: &Subspace) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Subspace> for Subspace

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

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

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

This method tests for !=.

impl PartialOrd<Subspace> for Subspace

fn partial_cmp(&self, other: &Subspace) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Subspace

impl StructuralEq for Subspace

impl StructuralPartialEq for Subspace