Merge pull request #554 from pjhades/impl-debug-for-row

libsql: implement Debug trait for Row

libsql/src/hrana/mod.rs

@@ -411,6 +411,7 @@ impl RowsInner for Rows {
     }
 }
 
+#[derive(Debug)]
 pub struct Row {
     cols: Arc<Vec<Col>>,
     inner: Vec<proto::Value>,

libsql/src/local/impls.rs

@@ -1,4 +1,5 @@
 use std::sync::Arc;
+use std::fmt;
 
 use crate::{
     connection::Conn,
@@ -162,3 +163,9 @@ impl RowInner for LibsqlRow {
         self.0.column_type(idx).map(ValueType::from)
     }
 }
+
+impl fmt::Debug for LibsqlRow {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> std::result::Result<(), fmt::Error> {
+        self.0.fmt(f)
+    }
+}

libsql/src/local/rows.rs

@@ -4,6 +4,7 @@ use crate::{errors, Error, Result};
 use crate::{Value, ValueRef};
 use libsql_sys::ValueType;
 
+use std::fmt;
 use std::cell::RefCell;
 use std::ffi::c_char;
 /// Query result rows.
@@ -151,6 +152,32 @@ impl Row {
     }
 }
 
+impl fmt::Debug for Row {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> std::result::Result<(), fmt::Error> {
+        let mut dbg_map = f.debug_map();
+        for column in 0..self.stmt.column_count() {
+            dbg_map.key(&self.stmt.column_name(column));
+            let value = self.get_ref(column as i32);
+            match value {
+                Ok(value_ref) => {
+                    let value_type = value_ref.data_type();
+                    match value_ref {
+                        ValueRef::Null => dbg_map.value(&(value_type, ())),
+                        ValueRef::Integer(i) => dbg_map.value(&(value_type, i)),
+                        ValueRef::Real(f) => dbg_map.value(&(value_type, f)),
+                        ValueRef::Text(s) => dbg_map.value(&(value_type, String::from_utf8_lossy(s))),
+                        ValueRef::Blob(b) => dbg_map.value(&(value_type, b.len())),
+                    };
+                }
+                Err(_) => {
+                    dbg_map.value(&value);
+                }
+            }
+        }
+        dbg_map.finish()
+    }
+}
+
 pub trait FromValue {
     fn from_sql(val: libsql_sys::Value) -> Result<Self>
     where

libsql/src/replication/connection.rs

@@ -615,6 +615,7 @@ impl RowsInner for RemoteRows {
     }
 }
 
+#[derive(Debug)]
 struct RemoteRow(Vec<Value>, Vec<libsql_replication::rpc::proxy::Column>);
 
 impl RowInner for RemoteRow {

libsql/src/rows.rs

@@ -1,4 +1,5 @@
 use crate::{Result, Value, ValueType};
+use std::fmt;
 
 // NOTICE: Column is blatantly copy-pasted from rusqlite
 pub struct Column<'stmt> {
@@ -99,6 +100,12 @@ impl Row {
     }
 }
 
+impl fmt::Debug for Row {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> std::result::Result<(), fmt::Error> {
+        self.inner.fmt(f)
+    }
+}
+
 pub trait FromValue {
     fn from_sql(val: Value) -> Result<Self>
     where
@@ -207,7 +214,7 @@ where
     }
 }
 
-pub(crate) trait RowInner {
+pub(crate) trait RowInner: fmt::Debug {
     fn column_value(&self, idx: i32) -> Result<Value>;
     fn column_str(&self, idx: i32) -> Result<&str>;
     fn column_name(&self, idx: i32) -> Option<&str>;

libsql/src/value.rs

@@ -230,6 +230,7 @@ impl From<libsql_sys::Value> for Value {
 }
 
 // Heavily inspired by rusqlite's ValueRef
+#[derive(Debug)]
 pub enum ValueRef<'a> {
     Null,
     Integer(i64),

libsql/tests/integration_tests.rs

@@ -338,3 +338,25 @@ async fn custom_params() {
     .await
     .unwrap();
 }
+
+#[tokio::test]
+async fn debug_print_row() {
+    let db = Database::open(":memory:").unwrap();
+    let conn = db.connect().unwrap();
+    let _ = conn
+        .execute(
+            "CREATE TABLE users (id INTEGER, name TEXT, score REAL, data BLOB, age INTEGER)",
+            (),
+        )
+        .await;
+    conn.execute("INSERT INTO users (id, name, score, data, age) VALUES (123, \"potato\", 3.14, X'deadbeef', NULL)", ())
+    .await
+    .unwrap();
+
+    let mut stmt = conn.prepare("SELECT * FROM users").await.unwrap();
+    let mut rows = stmt.query(()).await.unwrap();
+    assert_eq!(
+        format!("{:?}", rows.next().unwrap().unwrap()),
+        "{Some(\"id\"): (Integer, 123), Some(\"name\"): (Text, \"potato\"), Some(\"score\"): (Real, 3.14), Some(\"data\"): (Blob, 4), Some(\"age\"): (Null, ())}"
+    );
+}