Struct SchemaName 

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

A strongly typed database identifier wrapper: SchemaName.

Implementations

impl SchemaName

pub fn new(input: impl AsRef<str>) -> Result<SchemaName, DatabaseNameError>

Creates a database identifier from non-empty text.

Errors

Returns DatabaseNameError when the value is empty or contains control characters.

Examples found in repository

examples/basic_usage.rs (line 8)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let database = DatabaseName::new("app")?;
    let schema = SchemaName::new("public")?;
    let table = TableName::new("users")?;
    let column = ColumnName::new("id")?;

    let primary_key = PrimaryKey::new(table.clone(), column.clone());
    let page = PageRequest::new(1, 50);
    let isolation = TransactionIsolation::Serializable;

    assert_eq!(database.as_str(), "app");
    assert_eq!(schema.as_str(), "public");
    assert_eq!(primary_key.table(), &table);
    assert_eq!(primary_key.column(), &column);
    assert_eq!(page.per_page(), 50);
    assert_eq!(SortDirection::Ascending.as_str(), "ascending");
    assert_eq!(isolation.as_str(), "serializable");

    Ok(())
}

pub fn as_str(&self) -> &str

Returns the stored identifier text.

Examples found in repository

examples/basic_usage.rs (line 17)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let database = DatabaseName::new("app")?;
    let schema = SchemaName::new("public")?;
    let table = TableName::new("users")?;
    let column = ColumnName::new("id")?;

    let primary_key = PrimaryKey::new(table.clone(), column.clone());
    let page = PageRequest::new(1, 50);
    let isolation = TransactionIsolation::Serializable;

    assert_eq!(database.as_str(), "app");
    assert_eq!(schema.as_str(), "public");
    assert_eq!(primary_key.table(), &table);
    assert_eq!(primary_key.column(), &column);
    assert_eq!(page.per_page(), 50);
    assert_eq!(SortDirection::Ascending.as_str(), "ascending");
    assert_eq!(isolation.as_str(), "serializable");

    Ok(())
}

pub fn into_string(self) -> String

Consumes the identifier and returns the owned string.

Trait Implementations

impl AsRef<str> for SchemaName

fn as_ref(&self) -> &str

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

impl Clone for SchemaName

fn clone(&self) -> SchemaName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaName

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

Formats the value using the given formatter.

impl Display for SchemaName

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

Formats the value using the given formatter.

impl FromStr for SchemaName

type Err = DatabaseNameError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<SchemaName, <SchemaName as FromStr>::Err>

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

impl Hash for SchemaName

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 Ord for SchemaName

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

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

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

type Error = DatabaseNameError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<SchemaName, <SchemaName as TryFrom<&str>>::Error>

Performs the conversion.

impl Eq for SchemaName

impl StructuralPartialEq for SchemaName