Struct fdb_rl::RecordVersion

pub struct RecordVersion {
    incarnation_version: Option<u64>,
    global_version: Bytes,
    local_version: u16,
    complete: bool,
}

Type representing a specific version within FDB.

This is designed to inter-operate with the Versionstamp type used to serialize versions within FoundationDB. The version consists of three parts: a incarnation version, a global version, a local version.

The incarnation version must be set by the user, and must be incremented by the user each time the record is moved to a different FoundationDB cluster.

The global version is a 10 byte version that is set by the database, and is used to impose an ordering between different transactions within a FoundationDB cluster.

The local version should be set by the user, and it must be used to impose an order on different records within a single transaction.

Together the incarnation version, global version and local version are used to impose a total order across all records. Incarnation version and local version can be managed using RecordContext.

Fields

incarnation_version: Option<u64>

global_version: Bytes

Corresponds to tr_version field in the Versionstamp struct. In RecordLayer FDBRecordVersion class, this field is known as versionBytes.

local_version: u16

Corresponds to user_version field in the Versionstamp struct.

complete: bool

Implementations

impl RecordVersion

pub fn get_incarnation_version(&self) -> Option<u64>

Get incarnation version. When no incarnation version is present, then None is returned.

pub fn get_versionstamp(&self) -> Versionstamp

Get Versionstamp.

pub(crate) fn into_parts(self) -> (Option<u64>, Bytes, u16, bool)

Trait Implementations

impl Clone for RecordVersion

fn clone(&self) -> RecordVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RecordVersion

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

Formats the value using the given formatter.

impl From<(u64, Versionstamp)> for RecordVersion

fn from((i, vs): (u64, Versionstamp)) -> RecordVersion

Converts to this type from the input type.

impl From<Versionstamp> for RecordVersion

fn from(value: Versionstamp) -> RecordVersion

Converts to this type from the input type.

impl Ord for RecordVersion

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<RecordVersion> for RecordVersion

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

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

impl StructuralEq for RecordVersion

impl StructuralPartialEq for RecordVersion