Add derives

Author: ohsayan

.gitignore

@@ -2,6 +2,6 @@
 Cargo.lock
 .vscode
 .DS_Store
-examples/target
 scripts
-src/bin
+src/bin
+sky-derive/target

sky-derive/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "sky-derive"
+version = "0.2.0"
+edition = "2021"
+license = "Apache-2.0"
+description = "Macros for the Skytable client driver"
+homepage = "https://skytable.io"
+documentation = "https://docs.rs/skytable"
+repository = "https://github.com/skytable/client-rust"
+readme = "README.md"
+
+# Cargo.toml for the macro crate
+[lib]
+proc-macro = true
+
+[dependencies]
+syn = { version = "1", features = ["full"] }
+quote = "1"
+proc-macro2 = "1"

sky-derive/README.md

@@ -0,0 +1,3 @@
+# Skytable client driver macros
+
+This crate is meant to be used with the [Skytable Rust Client Driver](https://github.com/skytable/client-rust) and will not work otherwise (this crate has no standalone functionality).

sky-derive/src/lib.rs

@@ -0,0 +1,64 @@
+extern crate proc_macro;
+
+use proc_macro::TokenStream;
+use quote::quote;
+use syn::{parse_macro_input, DeriveInput, Data, Fields};
+
+#[proc_macro_derive(Query)]
+pub fn derive_query(input: TokenStream) -> TokenStream {
+    let input = parse_macro_input!(input as DeriveInput);
+    let name = input.ident;
+    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
+    let ret = match input.data {
+        Data::Struct(data_struct) => {
+            match data_struct.fields {
+                Fields::Named(fields) => {
+                    let field_names: Vec<_> = fields.named.iter().map(|f| &f.ident).collect();
+                    assert!(!field_names.is_empty(), "can't derive on empty field");
+                    quote! {
+                        impl #impl_generics ::skytable::query::SQParam for #name #ty_generics #where_clause {
+                            fn append_param(&self, q: &mut Vec<u8>) -> usize {
+                                let mut size = 0;
+                                #(size += ::skytable::query::SQParam::append_param(&self.#field_names, q);)*
+                                size
+                            }
+                        }
+                    }
+                },
+                _ => unimplemented!(),
+            }
+        },
+        _ => unimplemented!(),
+    };
+    TokenStream::from(ret)
+}
+
+#[proc_macro_derive(Response)]
+pub fn derive_response(input: TokenStream) -> TokenStream {
+    let input = parse_macro_input!(input as DeriveInput);
+    let name = input.ident;
+    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
+    let ret = match input.data {
+        Data::Struct(data_struct) => {
+            match data_struct.fields {
+                Fields::Named(fields) => {
+                    let field_names: Vec<_> = fields.named.iter().map(|f| &f.ident).collect();
+                    assert!(!field_names.is_empty(), "can't derive on empty field");
+                    let tuple_pattern = quote! { (#(#field_names),*) };
+                    let struct_instantiation = quote! { Self { #(#field_names),* } };    
+                    quote! {
+                        impl #impl_generics skytable::response::FromResponse for #name #ty_generics #where_clause {
+                            fn from_response(resp: skytable::response::Response) -> skytable::ClientResult<Self> {
+                                let #tuple_pattern = skytable::response::FromResponse::from_response(resp)?;
+                                Ok(#struct_instantiation)
+                            }
+                        }
+                    }
+                },
+                _ => unimplemented!(),
+            }
+        },
+        _ => unimplemented!(),
+    };
+    TokenStream::from(ret)
+}

src/lib.rs

@@ -16,64 +16,64 @@
 
 //! # Skytable driver
 //! [![Crates.io](https://img.shields.io/crates/v/skytable?style=flat-square)](https://crates.io/crates/skytable) [![Test](https://github.com/skytable/client-rust/actions/workflows/test.yml/badge.svg)](https://github.com/skytable/client-rust/actions/workflows/test.yml) [![docs.rs](https://img.shields.io/docsrs/skytable?style=flat-square)](https://docs.rs/skytable) [![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/skytable/client-rust?include_prereleases&style=flat-square)](https://github.com/skytable/client-rust/releases)
-//! 
+//!
 //! This is [Skytable](https://github.com/skytable/skytable)'s official client driver for Rust that you can use to build applications.
 //! The client-driver is distributed under the liberal [Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0) and hence
 //! you can use it in your applications without any licensing issues.
-//! 
+//!
 //! ## Getting started
-//! 
+//!
 //! Make sure you have Skytable set up. If not, follow the [official installation guide here](https://docs.skytable.io/installation)
 //! and then come back here.
-//! 
+//!
 //! Let's run our first query. Connections are set up using the [`Config`] object and then we establish a connection by calling
 //! [`Config::connect`] or use other functions for different connection configurations (for TLS or async).
-//! 
+//!
 //! ```no_run
 //! use skytable::{Config, query};
 //! let mut db = Config::new_default("username", "password").connect().unwrap();
 //! // the query `sysctl report status` returns a `Response::Empty` indicating that everything is okay. This is equivalent to
 //! // rust's unit type `()` so that's what the driver uses
 //! db.query_parse::<()>(&query!("sysctl report status")).unwrap();
 //! ```
-//! 
+//!
 //! We used the [`query!`] macro above which allows us to conveniently create queries when we don't need to handle complex
 //! cases and we have a fixed number of arguments.
-//! 
+//!
 //! ## Diving in
-//! 
+//!
 //! Now let's say that we have a model `create model myspace.mymodel(username: string, password: string, followers: uint64)`
 //! and we want to do some DML operations. Here's how we do it.
-//! 
+//!
 //! ```no_run
 //! use skytable::{Config, query};
 //! let mut db = Config::new_default("username", "password").connect().unwrap();
-//! 
+//!
 //! let insert_query = query!("insert into myspace.mymodel(?, ?, ?)", "sayan", "pass123", 1_500_000_u64);
 //! db.query_parse::<()>(&insert_query).unwrap(); // insert will return empty on success
-//! 
+//!
 //! let select_query = query!("select password, followers FROM myspace.mymodel WHERE username = ?", "sayan");
 //! let (pass, followers): (String, u64) = db.query_parse(&select_query).unwrap();
 //! assert_eq!(pass, "pass123");
 //! assert_eq!(followers, 1_500_000_u64);
-//! 
+//!
 //! let update_query = query!("update myspace.mymodel set followers += ? where username = ?", 1u64, "sayan");
 //! db.query_parse::<()>(&update_query).unwrap(); // update will return empty on success
 //! ```
-//! 
+//!
 //! Now you're ready to run your own queries!
-//! 
+//!
 //! ## Going advanced
-//! 
+//!
 //! - Custom [`mod@query`] generation
 //! - Custom [`response`] parsing
 //! - [`Connection pooling`](pool)
-//! 
+//!
 //! ## Need help? Get help!
-//! 
+//!
 //! Jump into [Skytable's official Discord server](https://discord.com/invite/QptWFdx) where maintainers, developers and fellow
 //! users help each other out.
-//! 
+//!
 
 // internal modules
 #[macro_use]