Struct TableName 

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

A table name as it appears in the syntax tree.

This is the form that renders: ToSql escapes the name when it would otherwise be read back as a reserved word, which is what makes DEFINE TABLE ⟨select⟩ round-trip. It is also the form that crosses the public boundary, since the wire’s surrealdb_types::Table is a language value rather than an engine or storage one.

Every AST node that renders a table name goes through that impl rather than naming an escaper itself, so how a table name escapes is decided in one place. A node that reaches for EscapeIdent directly is not wrong today, but it is a second place to change.

Lowering converts this to surrealdb_strand::TableName, which the engine passes around and which carries neither capability.

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

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 TableName

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

Formats the value using the given formatter.

impl Default for TableName

fn default() -> Self

Returns the “default value” for a type.

impl Display for TableName

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

Formats the value using the given formatter.

impl Eq for TableName

impl From<&str> for TableName

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Strand> for TableName

fn from(value: Strand) -> Self

Converts to this type from the input type.

impl From<String> for TableName

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Table> for TableName

fn from(value: Table) -> Self

Converts to this type from the input type.

impl From<TableName> for String

fn from(value: TableName) -> Self

Converts to this type from the input type.

impl From<TableName> for Strand

fn from(value: TableName) -> Self

Converts to this type from the input type.

impl<'a> From<TableName> for Cow<'a, str>

fn from(value: TableName) -> Self

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) -> Self

Converts to this type from the input type.

impl From<TableName> for TableName

Rendering: the engine’s name becomes the syntax tree’s, so that it prints with the escaping this layer owns.

fn from(value: TableName) -> Self

Converts to this type from the input type.

impl From<TableName> for Table

fn from(value: TableName) -> Self

Converts to this type from the input type.

impl Hash for TableName

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 TableName

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 TableName

fn eq(&self, other: &Self) -> 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<TableName> for str

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: &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 TableName

impl ToSql for TableName

fn fmt_sql(&self, f: &mut String, sql_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.