Struct SqlIdentifier

pub struct SqlIdentifier {
    pub case_sensitive: bool,
    /* private fields */
}

An SQL identifier.

This struct is used to represent SQL identifiers in a canonical form. We store table names or field names as identifiers in the schema.

Fields

case_sensitive: bool

Implementations

impl SqlIdentifier

pub fn new<S: AsRef<str>>(name: S, case_sensitive: bool) -> Self

pub fn name(&self) -> String

Return the name of the identifier in canonical form. The result is the true case-sensitive identifying name of the table, and can be used for example to detect duplicate table names.

Example return values for this function:

• CREATE TABLE t1 -> t1
• CREATE TABLE T1 -> t1
• CREATE TABLE "t1" -> t1
• CREATE TABLE "T1" -> T1

pub fn sql_name(&self) -> String

Return the name of the identifier as it appeared originally in SQL. This method should only be used for log or error messages as it is what the user originally wrote, however it should not be used for identification or disambiguation (use name() for that instead).

Example return values for this function:

• CREATE TABLE t1 -> t1
• CREATE TABLE T1 -> T1
• CREATE TABLE "t1" -> "t1"
• CREATE TABLE "T1" -> "T1"

Trait Implementations

impl Clone for SqlIdentifier

fn clone(&self) -> SqlIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqlIdentifier

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SqlIdentifier

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SqlIdentifier

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

Formats the value using the given formatter.

impl From<&SqlIdentifier> for String

fn from(id: &SqlIdentifier) -> String

Converts to this type from the input type.

impl<S: AsRef<str>> From<S> for SqlIdentifier

fn from(name: S) -> Self

Converts to this type from the input type.

impl From<SqlIdentifier> for String

fn from(id: SqlIdentifier) -> String

Converts to this type from the input type.

impl Hash for SqlIdentifier

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 SqlIdentifier

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.

impl<S: AsRef<str>> PartialEq<S> for SqlIdentifier

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

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

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 Serialize for SqlIdentifier

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for SqlIdentifier

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl Eq for SqlIdentifier