Enum RecordIdKey 

pub enum RecordIdKey {
    Number(i64),
    String(String),
    Uuid(Uuid),
    Array(Array),
    Object(Object),
    Range(Box<RecordIdKeyRange>),
}

Represents a key component of a record identifier in SurrealDB

Record identifiers can have various types of keys including numbers, strings, UUIDs, arrays, objects, or ranges. This enum provides type-safe representation for all key types.

Variants

Number(i64)

A numeric key

String(String)

A string key

Uuid(Uuid)

A UUID key

Array(Array)

An array key

Object(Object)

An object key

Range(Box<RecordIdKeyRange>)

A range key

Implementations

impl RecordIdKey

pub fn rand() -> RecordIdKey

Generate a new random ID

pub fn ulid() -> RecordIdKey

Generate a new random ULID

pub fn uuid() -> RecordIdKey

Generate a new random UUID

pub fn is_range(&self) -> bool

Returns if this key is a range.

Trait Implementations

impl Clone for RecordIdKey

fn clone(&self) -> RecordIdKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordIdKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RecordIdKey

fn deserialize<__D>( __deserializer: __D, ) -> Result<RecordIdKey, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for RecordIdKey

fn from(value: &str) -> RecordIdKey

Converts to this type from the input type.

impl From<Array> for RecordIdKey

fn from(value: Array) -> RecordIdKey

Converts to this type from the input type.

impl From<Box<RecordIdKeyRange>> for RecordIdKey

fn from(value: Box<RecordIdKeyRange>) -> RecordIdKey

Converts to this type from the input type.

impl From<Object> for RecordIdKey

fn from(value: Object) -> RecordIdKey

Converts to this type from the input type.

impl From<RecordIdKeyRange> for RecordIdKey

fn from(value: RecordIdKeyRange) -> RecordIdKey

Converts to this type from the input type.

impl From<String> for RecordIdKey

fn from(value: String) -> RecordIdKey

Converts to this type from the input type.

impl From<Uuid> for RecordIdKey

fn from(value: Uuid) -> RecordIdKey

Converts to this type from the input type.

impl From<i64> for RecordIdKey

fn from(value: i64) -> RecordIdKey

Converts to this type from the input type.

impl FromFlatbuffers for RecordIdKey

type Input<'a> = RecordIdKey<'a>

The input type from the flatbuffers builder

fn from_fb( input: <RecordIdKey as FromFlatbuffers>::Input<'_>, ) -> Result<RecordIdKey, Error>

Convert a flatbuffers builder type to a type.

impl Hash for RecordIdKey

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

where __H: Hasher,

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 RecordIdKey

fn cmp(&self, other: &RecordIdKey) -> 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.

impl PartialEq<Value> for RecordIdKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for RecordIdKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RecordIdKey

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SurrealValue for RecordIdKey

fn kind_of() -> Kind

Returns the kind that represents this type

fn is_value(value: &Value) -> bool

Checks if the given value can be converted to this type

fn into_value(self) -> Value

Converts this type into a SurrealDB value

fn from_value(value: Value) -> Result<RecordIdKey, Error>

Attempts to convert a SurrealDB value into this type

impl ToFlatbuffers for RecordIdKey

type Output<'bldr> = WIPOffset<RecordIdKey<'bldr>>

The output type for the flatbuffers builder

fn to_fb<'bldr>( &self, builder: &mut FlatBufferBuilder<'bldr>, ) -> Result<<RecordIdKey as ToFlatbuffers>::Output<'bldr>, Error>

Convert the type to a flatbuffers builder type.

impl ToSql for RecordIdKey

fn fmt_sql(&self, f: &mut String, fmt: SqlFormat)

Format the type to a SQL string.

fn to_sql(&self) -> String

Convert the type to a SQL string.

fn to_sql_pretty(&self) -> String

Convert the type to a pretty-printed SQL string with indentation.

impl Eq for RecordIdKey

impl StructuralPartialEq for RecordIdKey