Struct TableName 

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

A table name, as the engine holds it and as it is encoded to storage.

Deliberately carries no rendering and no conversion to the public wire type. Both belong to the language layer, where a name is escaped if it would otherwise read back as a reserved word — see surrealdb_sql::TableName. Keeping them off this type is what lets this crate stay a string primitive rather than depending on the formatting and public-type crates.

It also deliberately does not deref to str. str implements ToSql, so while it did, writing name.fmt_sql(..) resolved to the unescaped string rendering instead of failing to compile, and a name that could not be read back was emitted. Reaching the text requires TableName::as_str, which makes the choice of escaper explicit at every call site.

That absence is load-bearing rather than incidental, so it is pinned here: re-adding the impl makes this compile, and the test fails.

let name = surrealdb_strand::TableName::from("person");
let _: &str = &name;

Implementations

impl TableName

pub fn new(s: impl Into<Strand>) -> TableName

Create a new table name.

pub fn into_string(self) -> String

pub fn as_str(&self) -> &str

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

Trait Implementations

impl AsRef<str> for TableName

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for TableName

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<'de, F> BorrowDecode<'de, F> for TableName

fn borrow_decode(r: &mut BorrowReader<'de>) -> Result<TableName, DecodeError>

impl Cast for TableName

fn can_cast(v: &Value) -> bool

Returns true if calling cast on the value will succeed.

fn cast(v: Value) -> Result<Self, CastError>

Cast a value to the self type.

impl Clone for TableName

fn clone(&self) -> TableName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Coerce for TableName

fn can_coerce(v: &Value) -> bool

Returns if calling coerce on the value will succeed or not.

fn coerce(v: Value) -> Result<Self, CoerceError>

Coerce a value.

impl Debug for TableName

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

Formats the value using the given formatter.

impl<F> Decode<F> for TableName

fn decode<R>(r: &mut Reader<R>) -> Result<TableName, DecodeError>

where R: BufRead,

impl Default for TableName

fn default() -> TableName

Returns the “default value” for a type.

impl DeserializeRevisioned for TableName

fn deserialize_revisioned<R>(r: &mut R) -> Result<TableName, Error>

where R: Read,

Deserializes a new instance of the struct from the specified reader.

impl Display for TableName

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

Formats the value using the given formatter.

impl<F> Encode<F> for TableName

fn encode<W>(&self, w: &mut Writer<W>) -> Result<(), EncodeError>

where W: Write,

impl Eq for TableName

impl From<&str> for TableName

fn from(value: &str) -> TableName

Converts to this type from the input type.

impl From<Strand> for TableName

fn from(value: Strand) -> TableName

Converts to this type from the input type.

impl From<String> for TableName

fn from(value: String) -> TableName

Converts to this type from the input type.

impl From<TableName> for Strand

fn from(value: TableName) -> Strand

Converts to this type from the input type.

impl From<TableName> for TableName

Lowering: the syntax tree’s name becomes the engine’s.

fn from(value: TableName) -> TableName

Converts to this type from the input type.

impl From<TableName> for Value

fn from(v: TableName) -> Self

Converts to this type from the input type.

impl HasKind for TableName

fn kind() -> Kind

impl Hash for TableName

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 IntoPublicTable for TableName

fn into_public_table(self) -> PublicTable

impl LengthPrefixedBytes for TableName

impl Ord for TableName

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for TableName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<String> for TableName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<TableName> for &TableName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for TableName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TableName

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

fn revision() -> u16

Returns the current revision of this type.

fn type_id() -> TypeId

where Self: 'static,

Returns the type id of this type.

impl SerializeRevisioned for TableName

fn serialize_revisioned<W>(&self, w: &mut W) -> Result<(), Error>

where W: Write,

Serializes the struct using the specified writer.

impl SkipRevisioned for TableName

fn skip_revisioned<R>(r: &mut R) -> Result<(), Error>

where R: Read,

fn skip_revisioned_slice(r: &mut SliceReader<'_>) -> Result<(), Error>

Consume through bytes backed by SliceReader without allocating a buffer for bulk segments.

impl StructuralPartialEq for TableName

impl WalkRevisioned for TableName

type Walker<'r, R: BorrowedReader + 'r> = LeafWalker<'r, TableName, R>

Walker produced by walk_revisioned.

fn walk_revisioned<'r, R>( reader: &'r mut R, ) -> Result<<TableName as WalkRevisioned>::Walker<'r, R>, Error>

where R: BorrowedReader,

Read the type’s revision-level prefix and return a walker positioned at the start of the body.