Syntax extensions to automatically derive FromSql and ToSql implementations for Postgres enum,
domain, and composite types.
The generated code requires rust-postgres 0.14 or 0.15 and Rust 1.15.0 or higher.
Simply depend on the postgres-derive crate and register it as a plugin:
Cargo.toml ```toml
[dependencies] postgres-derive = "0.3" postgres = "0.15" ```
lib.rs ```rust
extern crate postgres;
extern crate postgres_derive;
pub enum Mood { Sad, Ok, Happy, }
// ... ```
Postgres enums correspond to C-like enums in Rust:
sql
CREATE TYPE "Mood" AS ENUM (
'Sad',
'Ok',
'Happy'
);
```rust
enum Mood { Sad, Ok, Happy, } ```
The implementations will expect exact matches between the type names and variants. The
#[postgres(...)] attribute can be used to adjust the names used on the Postgres side:
sql
CREATE TYPE mood AS ENUM (
'sad',
'ok',
'happy'
);
```rust
enum Mood { #[postgres(name = "sad")] Sad, #[postgres(name = "ok")] Ok, #[postgres(name = "happy")] Happy, } ```
Postgres domains correspond to tuple structs with one member in Rust:
sql
CREATE DOMAIN "SessionId" AS BYTEA CHECK(octet_length(VALUE) = 16);
```rust
struct SessionId(Vec
As above, the implementations will expect an exact match between the Rust and Postgres type names,
and the #[postgres(...)] attribute can be used to adjust that behavior:
sql
CREATE DOMAIN session_id AS BYTEA CHECK(octet_length(VALUE) = 16);
```rust
struct SessionId(Vec
Postgres composite types correspond to structs in Rust:
sql
CREATE TYPE "InventoryItem" AS (
name TEXT,
supplier_id INT,
price DOUBLE PRECISION
);
```rust
struct InventoryItem {
name: String,
supplier_id: i32,
price: Option
Again, the implementations will expect an exact match between the names of the Rust and Postgres
types and fields, which can be adjusted via the #[postgres(...)] attribute:
sql
CREATE TYPE inventory_item AS (
name TEXT,
supplier_id INT,
the_price DOUBLE PRECISION
);
```rust
struct InventoryItem {
name: String,
supplierid: i32,
#[postgres(name = "theprice")]
price: Option
Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.