Struct RecordId 

pub struct RecordId {
    pub table: Table,
    pub key: RecordIdKey,
}

Represents a record identifier in SurrealDB

A record identifier consists of a table name and a key that uniquely identifies a record within that table. This is the primary way to reference specific records.

Fields

table: Table

The name of the table containing the record

key: RecordIdKey

The key that uniquely identifies the record within the table

Implementations

impl RecordId

pub fn new(table: impl Into<Table>, key: impl Into<RecordIdKey>) -> RecordId

Creates a new record id from the given table and key

pub fn is_table_type(&self, tables: &[Table]) -> bool

Checks if the record id is of the specified type.

pub fn parse_simple(s: &str) -> Result<RecordId, Error>

Parses a record id which must be in the format of table:key.

Trait Implementations

impl Clone for RecordId

fn clone(&self) -> RecordId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RecordId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromFlatbuffers for RecordId

type Input<'a> = RecordId<'a>

The input type from the flatbuffers builder

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

Convert a flatbuffers builder type to a type.

impl Hash for RecordId

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 RecordId

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

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

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

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 RecordId

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<RecordId, Error>

Attempts to convert a SurrealDB value into this type

impl ToFlatbuffers for RecordId

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

The output type for the flatbuffers builder

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

Convert the type to a flatbuffers builder type.

impl ToSql for RecordId

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 RecordId

impl StructuralPartialEq for RecordId