Struct Ident 

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

A single identifier naming a definition, as it appears in the syntax tree.

This is the form that renders: ToSql quotes the name whenever emitting it bare would read back as something else, so a definition’s name survives being rendered and re-parsed. Statements hold this rather than a String or a Strand because both of those render their contents verbatim, which makes an unquoted name the silent default and a round-trip failure the result.

Escaping is decided here, once, so a statement can interpolate the name directly and be correct. A statement that reaches for an escaper itself is choosing a different rule than every other definition name.

Every position this appears in is introduced by a sigil or a path separator ($name, mod::name, ml::name), so a reserved word is unambiguous there and is emitted bare. A name in a position where it could instead be read as a keyword needs crate::TableName’s stricter rule, not this one.

This is for names that are a single identifier. It is not the right type for a ::-separated path such as a function name, whose segments are escaped individually, and not for a name that may be computed at runtime, which is an Expr.

Implementations

impl Ident

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

pub fn as_str(&self) -> &str

pub fn into_string(self) -> String

Trait Implementations

impl Clone for Ident

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 Ident

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

Formats the value using the given formatter.

impl Default for Ident

fn default() -> Self

Returns the “default value” for a type.

impl Display for Ident

Renders the name unescaped. Use ToSql to produce SurrealQL.

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

Formats the value using the given formatter.

impl Eq for Ident

impl From<&str> for Ident

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Ident> for String

fn from(value: Ident) -> Self

Converts to this type from the input type.

impl From<Ident> for Strand

fn from(value: Ident) -> Self

Converts to this type from the input type.

impl From<Strand> for Ident

fn from(value: Strand) -> Self

Converts to this type from the input type.

impl From<String> for Ident

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for Ident

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 Ident

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 Ident

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Ident

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 Ident

impl ToSql for Ident

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.