Initial commit

Author: ohsayan

.gitignore

@@ -0,0 +1,4 @@
+/target
+Cargo.lock
+.vscode
+.DS_Store

Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+name = "skytable"
+version = "0.1.0"
+authors = ["Sayan Nandan <[email protected]>"]
+edition = "2018"
+readme = "README.md"
+description = "Official Rust client driver for Skytable"
+license = "Apache-2.0"
+documentation = "https://docs.rs/skytable"
+repository = "https://github.com/skytable/client-rust"
+categories = []
+keywords = ["skytable", "driver", "client", "database", "nosql"]
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+bytes = "1.0.1"
+tokio = {version = "1.5.0", features = ["net", "io-util", "io-std"]}
+lazy_static = "1.4.0"
+
+[dev-dependencies]
+tokio = {version="1.5.0", features=["rt", "macros"]}

LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

README.md

@@ -0,0 +1,70 @@
+# Skytable client
+
+This library is the official client for the free and open-source NoSQL database
+[Skytable](https://github.com/skytable/skytable). First, go ahead and install Skytable by
+following the instructions [here](https://docs.skytable.io/getting-started). This library supports
+all Skytable versions that work with the [Terrapipe 1.0 Protocol](https://docs.skytable.io/Protocol/terrapipe).
+This version of the library was tested with the latest Skytable release
+(release [0.5.1](https://github.com/skytable/skytable/releases/v0.5.1)).
+
+## Using this library
+
+This library only ships with the bare minimum that is required for interacting with Skytable. Once you have
+Skytable installed and running, you're ready to follow this guide!
+
+We'll start by creating a new binary application and then running actions. Create a new binary application
+by running:
+```shell
+cargo new skyapp
+```
+**Tip**: You can see a full list of the available actions [here](https://docs.skytable.io/actions-overview).
+
+First add this to your `Cargo.toml` file:
+```toml
+skytable = "0.1.0"
+```
+Now open up your `src/main.rs` file and establish a connection to the server:
+```no_run
+use skytable::{Connection};
+async fn main() {
+    let mut con = Connection::new("127.0.0.1", 2003).await.unwrap();
+}
+```
+
+We get an error stating that `main()` cannot be `async`! Now [`Connection`] itself is an `async` connection
+and hence needs to `await`. This is when you'll need a runtime like [Tokio](https://tokio.rs). The Skytable
+database itself uses Tokio as its asynchronous runtime! So let's add `tokio` to our `Cargo.toml` and also add
+the `#[tokio::main]` macro on top of our main function:
+
+In `Cargo.toml`, add:
+```toml
+tokio = {version="1.5.0", features=["full"]}
+```
+And your `main.rs` should now look like:
+```no_run
+use skytable::{Connection, Query, Response, RespCode, DataType};
+#[tokio::main]
+async fn main() -> std::io::Result<()> {
+    let mut con = Connection::new("127.0.0.1", 2003).await?;
+}
+```
+
+Now let's run a [`Query`]! Add this below the previous line:
+```no_run
+let mut query = Query::new();
+query.arg("heya");
+let res = con.run_simple_query(query).await?;
+assert_eq!(res, Response::Item(DataType::Str("HEY!".to_owned())));
+```
+
+Way to go &mdash; you're all set! Now go ahead and run more advanced queries!
+
+## Contributing
+
+Open-source, and contributions ... &mdash; they're always welcome! For ideas and suggestions,
+[create an issue on GitHub](https://github.com/skytable/client-rust/issues/new) and for patches,
+fork and open those pull requests [here](https://github.com/skytable/client-rust)!
+
+## License
+This client library is distributed under the permissive 
+[Apache-2.0 License](https://github.com/skytable/client-rust/blob/next/LICENSE). Now go build great apps!

src/connection.rs

@@ -0,0 +1,102 @@
+/*
+ * Created on Wed May 05 2021
+ *
+ * Copyright (c) 2021 Sayan Nandan <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+*/
+
+//! # Database connections
+//! 
+//! This crate provides a [`Connection`] object that can be used to connect to a Skytable database instance
+//! and write/read queries/responses to/from it
+
+use crate::deserializer::{self, ClientResult};
+use crate::{Query, Response};
+use bytes::{Buf, BytesMut};
+pub use std::io::Result as IoResult;
+use std::io::{Error, ErrorKind};
+use tokio::io::{AsyncReadExt, AsyncWriteExt};
+use tokio::net::TcpStream;
+
+/// 4 KB Read Buffer
+const BUF_CAP: usize = 4096;
+
+/// A `Connection` is a wrapper around a`TcpStream` and a read buffer
+pub struct Connection {
+    stream: TcpStream,
+    buffer: BytesMut,
+}
+
+impl Connection {
+    /// Create a new connection to a Skytable instance hosted on `host` and running on `port`
+    pub async fn new(host: &str, port: u16) -> IoResult<Self> {
+        let stream = TcpStream::connect((host, port)).await?;
+        Ok(Connection {
+            stream: stream,
+            buffer: BytesMut::with_capacity(BUF_CAP),
+        })
+    }
+    /// This function will write a [`Query`] to the stream and read the response from the
+    /// server. It will then determine if the returned response is complete or incomplete
+    /// or invalid and return an appropriate variant of [`Response`] wrapped in [`IoResult`]
+    /// for any I/O errors that may occur
+    pub async fn run_simple_query(&mut self, mut query: Query) -> IoResult<Response> {
+        match query.write_query_to(&mut self.stream).await {
+            Ok(_) => (),
+            Err(e) => {
+                eprintln!("ERROR: Couldn't write data to socket");
+                return Err(e);
+            }
+        };
+        loop {
+            match self.stream.read_buf(&mut self.buffer).await {
+                Ok(_) => (),
+                Err(e) => return Err(e),
+            }
+            match self.try_response().await {
+                ClientResult::Empty => break Err(Error::from(ErrorKind::ConnectionReset)),
+                ClientResult::Incomplete => {
+                    continue;
+                }
+                ClientResult::Response(r, f) => {
+                    self.buffer.advance(f);
+                    if r.len() != 1 {
+                        break Ok(Response::InvalidResponse);
+                    } else {
+                        break Ok(Response::Array(r));
+                    }
+                }
+                ClientResult::ResponseItem(r, f) => {
+                    self.buffer.advance(f);
+                    break Ok(Response::Item(r));
+                }
+                ClientResult::InvalidResponse => {
+                    self.buffer.clear();
+                    break Ok(Response::InvalidResponse);
+                }
+                ClientResult::ParseError => {
+                    self.buffer.clear();
+                    break Ok(Response::ParseError);
+                }
+            }
+        }
+    }
+    /// This function is a subroutine of `run_query` used to parse the response packet
+    async fn try_response(&mut self) -> ClientResult {
+        if self.buffer.is_empty() {
+            // The connection was possibly reset
+            return ClientResult::Empty;
+        }
+        deserializer::parse(&self.buffer)
+    }
+}