Merge pull request #69 from axiomhq/arne/expose-table

Fix: Expose datasets::model::table::*

Author: bahlo

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "axiom-rs"
-version = "0.11.0"
+version = "0.11.1"
 authors = ["Arne Bahlo <arne@axiom.co>"]
 edition = "2018"
 rust-version = "1.60"

src/client.rs

@@ -60,7 +60,7 @@ pub struct Client {
 
 impl Client {
     /// Creates a new client. If you want to configure it, use [`Client::builder`].
-    ///     
+    ///
     /// # Errors
     /// If the client can not be created
     pub fn new() -> Result<Self> {
@@ -326,7 +326,7 @@ impl Builder {
         let mut org_id = self.org_id.unwrap_or_default();
         if org_id.is_empty() && env_fallback {
             org_id = env::var("AXIOM_ORG_ID").unwrap_or_default();
-        };
+        }
 
         // On Cloud you need an Org ID for Personal Tokens.
         if url == API_URL && org_id.is_empty() && is_personal_token(&token) {

src/datasets/model.rs

@@ -13,7 +13,8 @@ use std::{
     ops::Add,
     str::FromStr,
 };
-use table::Field;
+
+pub use table::*;
 
 use crate::serde::deserialize_null_default;
 

src/datasets/model/table.rs

@@ -40,6 +40,7 @@ impl AsRef<str> for FieldType {
     }
 }
 
+/// An aggregation.
 #[derive(Serialize, Deserialize, Debug, Eq, PartialEq)]
 pub struct Agg {
     // Name of the aggregation
@@ -267,18 +268,29 @@ impl Table {
         &self.columns
     }
 
+    /// Returns true if the first column is empty.
+    #[must_use]
+    pub fn is_empty(&self) -> bool {
+        self.len() == 0
+    }
+
     /// Returns the maximum length of the first column
     pub fn len(&self) -> usize {
         self.columns.first().map(Vec::len).unwrap_or_default()
     }
 
+    /// Returns a single row from the table.
+    #[must_use]
     pub fn get_row(&self, row: usize) -> Option<Row> {
         if self.len() > row {
             Some(Row { table: self, row })
         } else {
             None
         }
     }
+
+    /// Returns an iterator over the rows.
+    #[must_use]
     pub fn iter(&self) -> RowIter {
         RowIter {
             table: self,
@@ -287,6 +299,14 @@ impl Table {
     }
 }
 
+impl<'table> IntoIterator for &'table Table {
+    type Item = Row<'table>;
+    type IntoIter = RowIter<'table>;
+    fn into_iter(self) -> Self::IntoIter {
+        self.iter()
+    }
+}
+
 /// Iterator over the rows of a table.
 pub struct RowIter<'table> {
     table: &'table Table,
@@ -317,10 +337,10 @@ impl<'table> Iterator for RowIter<'table> {
     where
         Self: Sized,
     {
-        if self.table.len() > 0 {
-            self.table.get_row(self.table.len() - 1)
-        } else {
+        if self.table.is_empty() {
             None
+        } else {
+            self.table.get_row(self.table.len() - 1)
         }
     }
 }
@@ -333,6 +353,7 @@ pub struct Row<'table> {
 
 impl<'table> Row<'table> {
     /// Returns the value of the row by name
+    #[must_use]
     pub fn get_field(&self, field: &str) -> Option<&JsonValue> {
         let mut index = None;
 
@@ -346,6 +367,7 @@ impl<'table> Row<'table> {
         self.get(index?)
     }
     /// Returns the value of the row.
+    #[must_use]
     pub fn get(&self, column: usize) -> Option<&JsonValue> {
         self.table.columns.get(column).and_then(|c| c.get(self.row))
     }
@@ -365,6 +387,14 @@ impl<'table> Row<'table> {
     }
 }
 
+impl<'table> IntoIterator for &Row<'table> {
+    type Item = Option<&'table JsonValue>;
+    type IntoIter = FieldIter<'table>;
+    fn into_iter(self) -> Self::IntoIter {
+        self.iter()
+    }
+}
+
 /// Iterator over the fields of a row.
 pub struct FieldIter<'table> {
     table: &'table Table,