Struct Name 

pub struct Name { /* private fields */ }

Represents an escaped SQL identifier name.

Name stores both the properly quoted/escaped version (safe for SQL) and the original unescaped version (for display/logging).

Example

use hyperdb_api::Name;

let name = Name::try_new("users")?;
assert_eq!(name.to_string(), "\"users\"");
assert_eq!(name.unescaped(), "users");

Implementations

impl Name

pub fn try_new(name: impl Into<String>) -> Result<Self>

Creates a new escaped SQL name.

Errors

Returns an error if the name is empty or exceeds the PostgreSQL identifier limit (63 characters).

Example

use hyperdb_api::Name;

let name = Name::try_new("users")?;
assert_eq!(name.unescaped(), "users");

pub fn as_str(&self) -> &str

Returns the properly quoted and escaped string representation.

This is safe to use directly in SQL queries.

pub fn unescaped(&self) -> &str

Returns the original unescaped name.

Warning: Do not use this in SQL queries as it may be vulnerable to SQL injection. Use this only for logging or display purposes.

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Display for Name

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

Formats the value using the given formatter.

impl From<Name> for DatabaseName

fn from(name: Name) -> Self

Converts to this type from the input type.

impl From<Name> for SchemaName

fn from(name: Name) -> Self

Converts to this type from the input type.

impl From<Name> for TableName

fn from(name: Name) -> Self

Converts to this type from the input type.

impl FromStr for Name

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for Name

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 Name

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 PartialEq for Name

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 Name

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 TryFrom<&String> for Name

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &String) -> Result<Self>

Performs the conversion.

impl TryFrom<&str> for Name

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for Name

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self>

Performs the conversion.

impl Eq for Name