Struct PrimaryKey 

pub struct PrimaryKey { /* private fields */ }

Primary key metadata.

Implementations

impl PrimaryKey

pub const fn new(table: TableName, column: ColumnName) -> PrimaryKey

Creates single-column primary key metadata.

Examples found in repository

examples/basic_usage.rs (line 12)

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 const fn table(&self) -> &TableName

Returns the table name.

Examples found in repository

examples/basic_usage.rs (line 18)

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 const fn column(&self) -> &ColumnName

Returns the column name.

Examples found in repository

examples/basic_usage.rs (line 19)

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(())
}

Trait Implementations

impl Clone for PrimaryKey

fn clone(&self) -> PrimaryKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrimaryKey

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

Formats the value using the given formatter.

impl Hash for PrimaryKey

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 PrimaryKey

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

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

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

impl StructuralPartialEq for PrimaryKey