Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Derive transparent #857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions postgres-derive-test/src/compile-fail/invalid-transparent.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
use postgres_types::{FromSql, ToSql};

#[derive(ToSql, Debug)]
#[postgres(transparent)]
struct ToSqlTransparentStruct {
a: i32
}

#[derive(FromSql, Debug)]
#[postgres(transparent)]
struct FromSqlTransparentStruct {
a: i32
}

#[derive(ToSql, Debug)]
#[postgres(transparent)]
enum ToSqlTransparentEnum {
Foo
}

#[derive(FromSql, Debug)]
#[postgres(transparent)]
enum FromSqlTransparentEnum {
Foo
}

#[derive(ToSql, Debug)]
#[postgres(transparent)]
struct ToSqlTransparentTwoFieldTupleStruct(i32, i32);

#[derive(FromSql, Debug)]
#[postgres(transparent)]
struct FromSqlTransparentTwoFieldTupleStruct(i32, i32);

fn main() {}
49 changes: 49 additions & 0 deletions postgres-derive-test/src/compile-fail/invalid-transparent.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
error: #[postgres(transparent)] may only be applied to single field tuple structs
--> src/compile-fail/invalid-transparent.rs:4:1
|
4 | / #[postgres(transparent)]
5 | | struct ToSqlTransparentStruct {
6 | | a: i32
7 | | }
| |_^

error: #[postgres(transparent)] may only be applied to single field tuple structs
--> src/compile-fail/invalid-transparent.rs:10:1
|
10 | / #[postgres(transparent)]
11 | | struct FromSqlTransparentStruct {
12 | | a: i32
13 | | }
| |_^

error: #[postgres(transparent)] may only be applied to single field tuple structs
--> src/compile-fail/invalid-transparent.rs:16:1
|
16 | / #[postgres(transparent)]
17 | | enum ToSqlTransparentEnum {
18 | | Foo
19 | | }
| |_^

error: #[postgres(transparent)] may only be applied to single field tuple structs
--> src/compile-fail/invalid-transparent.rs:22:1
|
22 | / #[postgres(transparent)]
23 | | enum FromSqlTransparentEnum {
24 | | Foo
25 | | }
| |_^

error: #[postgres(transparent)] may only be applied to single field tuple structs
--> src/compile-fail/invalid-transparent.rs:28:1
|
28 | / #[postgres(transparent)]
29 | | struct ToSqlTransparentTwoFieldTupleStruct(i32, i32);
| |_____________________________________________________^

error: #[postgres(transparent)] may only be applied to single field tuple structs
--> src/compile-fail/invalid-transparent.rs:32:1
|
32 | / #[postgres(transparent)]
33 | | struct FromSqlTransparentTwoFieldTupleStruct(i32, i32);
| |_______________________________________________________^
1 change: 1 addition & 0 deletions postgres-derive-test/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use std::fmt;
mod composites;
mod domains;
mod enums;
mod transparent;

pub fn test_type<T, S>(conn: &mut Client, sql_type: &str, checks: &[(T, S)])
where
Expand Down
18 changes: 18 additions & 0 deletions postgres-derive-test/src/transparent.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
use postgres::{Client, NoTls};
use postgres_types::{FromSql, ToSql};

#[test]
fn round_trip() {
#[derive(FromSql, ToSql, Debug, PartialEq)]
#[postgres(transparent)]
struct UserId(i32);

assert_eq!(
Client::connect("user=postgres host=localhost port=5433", NoTls)
.unwrap()
.query_one("SELECT $1::integer", &[&UserId(123)])
.unwrap()
.get::<_, UserId>(0),
UserId(123)
);
}
8 changes: 8 additions & 0 deletions postgres-derive/src/accepts.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ use syn::Ident;
use crate::composites::Field;
use crate::enums::Variant;

pub fn transparent_body(field: &syn::Field) -> TokenStream {
let ty = &field.ty;

quote! {
<#ty as ::postgres_types::ToSql>::accepts(type_)
}
}

pub fn domain_body(name: &str, field: &syn::Field) -> TokenStream {
let ty = &field.ty;

Expand Down
37 changes: 36 additions & 1 deletion postgres-derive/src/fromsql.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,36 @@ use crate::overrides::Overrides;
pub fn expand_derive_fromsql(input: DeriveInput) -> Result<TokenStream, Error> {
let overrides = Overrides::extract(&input.attrs)?;

if overrides.name.is_some() && overrides.transparent {
return Err(Error::new_spanned(
&input,
"#[postgres(transparent)] is not allowed with #[postgres(name = \"...\")]",
));
}

let name = overrides.name.unwrap_or_else(|| input.ident.to_string());

let (accepts_body, to_sql_body) = match input.data {
let (accepts_body, to_sql_body) = if overrides.transparent {
match input.data {
Data::Struct(DataStruct {
fields: Fields::Unnamed(ref fields),
..
}) if fields.unnamed.len() == 1 => {
let field = fields.unnamed.first().unwrap();
(
accepts::transparent_body(field),
transparent_body(&input.ident, field),
)
}
_ => {
return Err(Error::new_spanned(
input,
"#[postgres(transparent)] may only be applied to single field tuple structs",
))
}
}
} else {
match input.data {
Data::Enum(ref data) => {
let variants = data
.variants
Expand Down Expand Up @@ -55,6 +82,7 @@ pub fn expand_derive_fromsql(input: DeriveInput) -> Result<TokenStream, Error> {
"#[derive(FromSql)] may only be applied to structs, single field tuple structs, and enums",
))
}
}
};

let ident = &input.ident;
Expand All @@ -77,6 +105,13 @@ pub fn expand_derive_fromsql(input: DeriveInput) -> Result<TokenStream, Error> {
Ok(out)
}

fn transparent_body(ident: &Ident, field: &syn::Field) -> TokenStream {
let ty = &field.ty;
quote! {
<#ty as postgres_types::FromSql>::from_sql(_type, buf).map(#ident)
}
}

fn enum_body(ident: &Ident, variants: &[Variant]) -> TokenStream {
let variant_names = variants.iter().map(|v| &v.name);
let idents = iter::repeat(ident);
Expand Down
7 changes: 5 additions & 2 deletions postgres-derive/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
extern crate proc_macro;

use proc_macro::TokenStream;
use syn::parse_macro_input;

mod accepts;
mod composites;
Expand All @@ -14,15 +15,17 @@ mod tosql;

#[proc_macro_derive(ToSql, attributes(postgres))]
pub fn derive_tosql(input: TokenStream) -> TokenStream {
let input = syn::parse(input).unwrap();
let input = parse_macro_input!(input);

tosql::expand_derive_tosql(input)
.unwrap_or_else(|e| e.to_compile_error())
.into()
}

#[proc_macro_derive(FromSql, attributes(postgres))]
pub fn derive_fromsql(input: TokenStream) -> TokenStream {
let input = syn::parse(input).unwrap();
let input = parse_macro_input!(input);

fromsql::expand_derive_fromsql(input)
.unwrap_or_else(|e| e.to_compile_error())
.into()
Expand Down
20 changes: 14 additions & 6 deletions postgres-derive/src/overrides.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@ use syn::{Attribute, Error, Lit, Meta, NestedMeta};

pub struct Overrides {
pub name: Option<String>,
pub transparent: bool,
}

impl Overrides {
pub fn extract(attrs: &[Attribute]) -> Result<Overrides, Error> {
let mut overrides = Overrides { name: None };
let mut overrides = Overrides {
name: None,
transparent: false,
};

for attr in attrs {
let attr = match attr.parse_meta() {
Ok(meta) => meta,
Err(_) => continue,
};
let attr = attr.parse_meta()?;

if !attr.path().is_ident("postgres") {
continue;
Expand All @@ -39,7 +40,14 @@ impl Overrides {

overrides.name = Some(value);
}
bad => return Err(Error::new_spanned(bad, "expected a name-value meta item")),
NestedMeta::Meta(Meta::Path(ref path)) => {
if !path.is_ident("transparent") {
return Err(Error::new_spanned(path, "unknown override"));
}

overrides.transparent = true;
}
bad => return Err(Error::new_spanned(bad, "unknown attribute")),
}
}
}
Expand Down
107 changes: 70 additions & 37 deletions postgres-derive/src/tosql.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,46 +11,73 @@ use crate::overrides::Overrides;
pub fn expand_derive_tosql(input: DeriveInput) -> Result<TokenStream, Error> {
let overrides = Overrides::extract(&input.attrs)?;

if overrides.name.is_some() && overrides.transparent {
return Err(Error::new_spanned(
&input,
"#[postgres(transparent)] is not allowed with #[postgres(name = \"...\")]",
));
}

let name = overrides.name.unwrap_or_else(|| input.ident.to_string());

let (accepts_body, to_sql_body) = match input.data {
Data::Enum(ref data) => {
let variants = data
.variants
.iter()
.map(Variant::parse)
.collect::<Result<Vec<_>, _>>()?;
(
accepts::enum_body(&name, &variants),
enum_body(&input.ident, &variants),
)
}
Data::Struct(DataStruct {
fields: Fields::Unnamed(ref fields),
..
}) if fields.unnamed.len() == 1 => {
let field = fields.unnamed.first().unwrap();
(accepts::domain_body(&name, field), domain_body())
}
Data::Struct(DataStruct {
fields: Fields::Named(ref fields),
..
}) => {
let fields = fields
.named
.iter()
.map(Field::parse)
.collect::<Result<Vec<_>, _>>()?;
(
accepts::composite_body(&name, "ToSql", &fields),
composite_body(&fields),
)
let (accepts_body, to_sql_body) = if overrides.transparent {
match input.data {
Data::Struct(DataStruct {
fields: Fields::Unnamed(ref fields),
..
}) if fields.unnamed.len() == 1 => {
let field = fields.unnamed.first().unwrap();

(accepts::transparent_body(field), transparent_body())
}
_ => {
return Err(Error::new_spanned(
input,
"#[postgres(transparent)] may only be applied to single field tuple structs",
));
}
}
_ => {
return Err(Error::new_spanned(
input,
"#[derive(ToSql)] may only be applied to structs, single field tuple structs, and enums",
));
} else {
match input.data {
Data::Enum(ref data) => {
let variants = data
.variants
.iter()
.map(Variant::parse)
.collect::<Result<Vec<_>, _>>()?;
(
accepts::enum_body(&name, &variants),
enum_body(&input.ident, &variants),
)
}
Data::Struct(DataStruct {
fields: Fields::Unnamed(ref fields),
..
}) if fields.unnamed.len() == 1 => {
let field = fields.unnamed.first().unwrap();

(accepts::domain_body(&name, field), domain_body())
}
Data::Struct(DataStruct {
fields: Fields::Named(ref fields),
..
}) => {
let fields = fields
.named
.iter()
.map(Field::parse)
.collect::<Result<Vec<_>, _>>()?;
(
accepts::composite_body(&name, "ToSql", &fields),
composite_body(&fields),
)
}
_ => {
return Err(Error::new_spanned(
input,
"#[derive(ToSql)] may only be applied to structs, single field tuple structs, and enums",
));
}
}
};

Expand Down Expand Up @@ -78,6 +105,12 @@ pub fn expand_derive_tosql(input: DeriveInput) -> Result<TokenStream, Error> {
Ok(out)
}

fn transparent_body() -> TokenStream {
quote! {
postgres_types::ToSql::to_sql(&self.0, _type, buf)
}
}

fn enum_body(ident: &Ident, variants: &[Variant]) -> TokenStream {
let idents = iter::repeat(ident);
let variant_idents = variants.iter().map(|v| &v.ident);
Expand Down
Loading