Struct RowIdentity 

pub struct RowIdentity(/* private fields */);

The identity a client sees for a row.

A minted row renders its surrogate in decimal. A row with a declared PRIMARY KEY carries the user’s own value.

Implementations

impl RowIdentity

pub fn for_surrogate(surrogate: Surrogate) -> Self

The decimal identity of a minted row.

pub fn of_stored_row( body: &[u8], declared_primary_key: Option<&str>, key: StorageKey, ) -> RowIdentity

The identity INSERT mints for a row, applied to a stored body.

The identity column is declared_primary_key, else DEFAULT_IDENTITY_COLUMN. A body carrying that column yields its value. A body without it yields its ROWID_COLUMN value, and a body with neither yields the decimal surrogate of key. A first write sets _rowid to that same surrogate, so the two agree until a copy moves the row to a new surrogate.

pub fn of_row_value( row: &Value, declared_primary_key: Option<&str>, key: StorageKey, ) -> RowIdentity

Self::of_stored_row applied to a decoded row. A row that is not an object yields the decimal surrogate of key. A scan that projects the identity columns returns a row this reads the same identity from.

pub fn from_user_key(key: impl Into<String>) -> Self

Wrap a declared or client-supplied key as the row’s identity.

The value is taken verbatim and never interpreted as a storage key or a surrogate. This is what makes it safe to call with a KV key, a user-declared primary key, or any other engine-native identifier.

Takes impl Into<String> so an owned String moves in without a copy. A &str caller still pays one copy, which is unavoidable.

pub fn as_str(&self) -> &str

pub fn into_string(self) -> String

Consume this identity and return its inner String without copying.

Trait Implementations

impl Clone for RowIdentity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RowIdentity

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

Formats the value using the given formatter.

impl Display for RowIdentity

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

Formats the value using the given formatter.

impl Eq for RowIdentity

impl Hash for RowIdentity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RowIdentity

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for RowIdentity

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RowIdentity

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for RowIdentity