From 7a3e07d98ddb2a828deac7c5d1a51423cdc7c53f Mon Sep 17 00:00:00 2001
From: Tpt <thomaspt@hotmail.fr>
Date: Sat, 16 Sep 2023 15:19:14 +0200
Subject: [PATCH] sparesults: no more hidden flush

Let the user decide to do it or not
---
 lib/sparesults/src/csv.rs        | 22 ++++++++++------------
 lib/sparesults/src/json.rs       |  4 +---
 lib/sparesults/src/serializer.rs |  4 ++--
 lib/sparesults/src/xml.rs        |  4 +---
 4 files changed, 14 insertions(+), 20 deletions(-)

diff --git a/lib/sparesults/src/csv.rs b/lib/sparesults/src/csv.rs
index ff33ce30..72adac29 100644
--- a/lib/sparesults/src/csv.rs
+++ b/lib/sparesults/src/csv.rs
@@ -55,9 +55,8 @@ impl<W: Write> CsvSolutionsWriter<W> {
         self.sink.write_all(b"\r\n")
     }
 
-    pub fn finish(mut self) -> io::Result<W> {
-        self.sink.flush()?;
-        Ok(self.sink)
+    pub fn finish(self) -> W {
+        self.sink
     }
 }
 
@@ -146,9 +145,8 @@ impl<W: Write> TsvSolutionsWriter<W> {
         self.sink.write_all(b"\n")
     }
 
-    pub fn finish(mut self) -> io::Result<W> {
-        self.sink.flush()?;
-        Ok(self.sink)
+    pub fn finish(self) -> W {
+        self.sink
     }
 }
 
@@ -436,7 +434,7 @@ mod tests {
                     .filter_map(|(v, s)| s.as_ref().map(|s| (v.as_ref(), s.as_ref()))),
             )?;
         }
-        let result = writer.finish()?;
+        let result = writer.finish();
         assert_eq!(str::from_utf8(&result).unwrap(), "x,literal\r\nhttp://example/x,String\r\nhttp://example/x,\"String-with-dquote\"\"\"\r\n_:b0,Blank node\r\n,Missing 'x'\r\n,\r\nhttp://example/x,\r\n_:b1,String-with-lang\r\n_:b1,123\r\n,\"escape,\t\r\n\"\r\n");
         Ok(())
     }
@@ -456,7 +454,7 @@ mod tests {
                     .filter_map(|(v, s)| s.as_ref().map(|s| (v.as_ref(), s.as_ref()))),
             )?;
         }
-        let result = writer.finish()?;
+        let result = writer.finish();
         assert_eq!(str::from_utf8(&result).unwrap(), "?x\t?literal\n<http://example/x>\t\"String\"\n<http://example/x>\t\"String-with-dquote\\\"\"\n_:b0\t\"Blank node\"\n\t\"Missing 'x'\"\n\t\n<http://example/x>\t\n_:b1\t\"String-with-lang\"@en\n_:b1\t123\n\t\"escape,\\t\\r\\n\"\n");
 
         // Read
@@ -507,7 +505,7 @@ mod tests {
     fn test_no_columns_csv_serialization() -> io::Result<()> {
         let mut writer = CsvSolutionsWriter::start(Vec::new(), Vec::new())?;
         writer.write([])?;
-        let result = writer.finish()?;
+        let result = writer.finish();
         assert_eq!(str::from_utf8(&result).unwrap(), "\r\n\r\n");
         Ok(())
     }
@@ -516,7 +514,7 @@ mod tests {
     fn test_no_columns_tsv_serialization() -> io::Result<()> {
         let mut writer = TsvSolutionsWriter::start(Vec::new(), Vec::new())?;
         writer.write([])?;
-        let result = writer.finish()?;
+        let result = writer.finish();
         assert_eq!(str::from_utf8(&result).unwrap(), "\n\n");
         Ok(())
     }
@@ -540,7 +538,7 @@ mod tests {
     #[test]
     fn test_no_results_csv_serialization() -> io::Result<()> {
         let result =
-            CsvSolutionsWriter::start(Vec::new(), vec![Variable::new_unchecked("a")])?.finish()?;
+            CsvSolutionsWriter::start(Vec::new(), vec![Variable::new_unchecked("a")])?.finish();
         assert_eq!(str::from_utf8(&result).unwrap(), "a\r\n");
         Ok(())
     }
@@ -548,7 +546,7 @@ mod tests {
     #[test]
     fn test_no_results_tsv_serialization() -> io::Result<()> {
         let result =
-            TsvSolutionsWriter::start(Vec::new(), vec![Variable::new_unchecked("a")])?.finish()?;
+            TsvSolutionsWriter::start(Vec::new(), vec![Variable::new_unchecked("a")])?.finish();
         assert_eq!(str::from_utf8(&result).unwrap(), "?a\n");
         Ok(())
     }
diff --git a/lib/sparesults/src/json.rs b/lib/sparesults/src/json.rs
index cacc4c59..67e2d494 100644
--- a/lib/sparesults/src/json.rs
+++ b/lib/sparesults/src/json.rs
@@ -67,9 +67,7 @@ impl<W: Write> JsonSolutionsWriter<W> {
         self.writer.write_event(JsonEvent::EndArray)?;
         self.writer.write_event(JsonEvent::EndObject)?;
         self.writer.write_event(JsonEvent::EndObject)?;
-        let mut inner = self.writer.into_inner();
-        inner.flush()?;
-        Ok(inner)
+        Ok(self.writer.into_inner())
     }
 }
 
diff --git a/lib/sparesults/src/serializer.rs b/lib/sparesults/src/serializer.rs
index 2ce77f4d..6f5bc7dc 100644
--- a/lib/sparesults/src/serializer.rs
+++ b/lib/sparesults/src/serializer.rs
@@ -195,8 +195,8 @@ impl<W: Write> ToWriteSolutionsWriter<W> {
         match self.formatter {
             ToWriteSolutionsWriterKind::Xml(write) => write.finish(),
             ToWriteSolutionsWriterKind::Json(write) => write.finish(),
-            ToWriteSolutionsWriterKind::Csv(write) => write.finish(),
-            ToWriteSolutionsWriterKind::Tsv(write) => write.finish(),
+            ToWriteSolutionsWriterKind::Csv(write) => Ok(write.finish()),
+            ToWriteSolutionsWriterKind::Tsv(write) => Ok(write.finish()),
         }
     }
 }
diff --git a/lib/sparesults/src/xml.rs b/lib/sparesults/src/xml.rs
index f7e0bb41..84e7e099 100644
--- a/lib/sparesults/src/xml.rs
+++ b/lib/sparesults/src/xml.rs
@@ -92,9 +92,7 @@ impl<W: Write> XmlSolutionsWriter<W> {
     }
 
     pub fn finish(self) -> io::Result<W> {
-        let mut inner = self.do_finish().map_err(map_xml_error)?;
-        inner.flush()?;
-        Ok(inner)
+        self.do_finish().map_err(map_xml_error)
     }
 
     fn do_finish(mut self) -> Result<W, quick_xml::Error> {