v1.0.1

* TPrint::print() now returns io::Result<()>
* Documentation improvements

Author: wizzard

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "tprint"
-version = "1.0.0"
+version = "1.0.1"
 authors = ["Paul Jonkins <[email protected]>"]
 edition = "2021"
 description = "A simple crate to print tabular data"
@@ -19,17 +19,4 @@ chrono = "0.4.39"
 
 [features]
 default = ["unicode"]
-unicode = ["dep:unicode-width"]
-
-
-[[example]]
-name = "basic_usage"
-path = "examples/basic_usage.rs"
-
-[[example]]
-name = "file_output"
-path = "examples/file_output.rs"
-
-[[example]]
-name = "html_output"
-path = "examples/html_output.rs"
+unicode = ["dep:unicode-width"]

README.md

@@ -27,7 +27,7 @@ A similar C library: [libtprint](https://github.com/wizzard/libtprint)
 ```rust
 use tprint::{TPrint, TPrintAlign};
 
-fn main() {
+fn main() -> std::io::Result<()> {
     TPrint::new(true, true, 10, 3).
         column_add("Name", TPrintAlign::Center, TPrintAlign::Left).
         column_add("Age", TPrintAlign::Center, TPrintAlign::Center).
@@ -44,7 +44,7 @@ fn main() {
         add_data("Madrid").
         add_data("Accountant").
         add_data("❤️😴🤦🏼‍♂️").
-        print();
+        print()
 }
 ```
 
@@ -57,7 +57,7 @@ use tprint::{TPrint, TPrintAlign, TPrintOutputString, TPrintBordersUnicode};
 use std::cell::RefCell;
 use std::rc::Rc;
 
-fn main() {
+fn main() -> std::io::Result<()> {
     let str_output = Rc::new(RefCell::new(TPrintOutputString::new()));
     let borders = Rc::new(RefCell::new(TPrintBordersUnicode {}));
     let mut str_tprint = TPrint::new_with_borders_output(borders, str_output.clone(), true, true, 0, 1);
@@ -79,6 +79,7 @@ fn main() {
     str_tprint.print();
 
     println!("{}", str_output.borrow().get_str());
+    Ok(())
 }
 ```
 
@@ -93,7 +94,7 @@ use std::rc::Rc;
 
 const OUT_FILE: &str = "/tmp/tprint.html";
 
-fn main() {
+fn main() -> std::io::Result<()> {
     let output = Rc::new(RefCell::new(TPrintOutputFile::new(OUT_FILE).unwrap()));
     let borders = Rc::new(RefCell::new(TPrintBordersHTML {}));
     TPrint::new_with_borders_output(borders, output, true, true, 0, 1).
@@ -112,8 +113,7 @@ fn main() {
         add_data("Madrid").
         add_data("Accountant").
         add_data("❤️😴🤦🏼‍♂️").
-        print();
-    println!();
+        print()
 }
 ```
 

examples/basic_usage.rs

@@ -1,6 +1,6 @@
 use tprint::{TPrint, TPrintAlign};
 
-fn main() {
+fn main() -> std::io::Result<()> {
     println!("1. Basic usage example: a table with 5 columns and 2 rows, with 10 spaces of padding from the left:");
     TPrint::new(true, true, 10, 3).
         column_add("Name", TPrintAlign::Center, TPrintAlign::Left).
@@ -18,10 +18,9 @@ fn main() {
         add_data("Madrid").
         add_data("Accountant").
         add_data("❤️😴🤦🏼‍♂️").
-        print();
-    println!();
+        print()?;
 
-    println!("2. Basic usage example: a table without borders with 5 columns and 2 rows, with 10 spaces of padding from the left:");
+    println!("\n2. Basic usage example: a table without borders with 5 columns and 2 rows, with 10 spaces of padding from the left:");
     TPrint::new(false, true, 10, 3).
         column_add("Name", TPrintAlign::Center, TPrintAlign::Left).
         column_add("Age", TPrintAlign::Center, TPrintAlign::Center).
@@ -38,10 +37,9 @@ fn main() {
         add_data("Madrid").
         add_data("Accountant").
         add_data("❤️😴🤦🏼‍♂️").
-        print();
-    println!();
+        print()?;
 
-    println!("3. Basic usage example: a table without borders and headers with 5 columns and 2 rows, with 10 spaces of padding from the left:");
+    println!("\n3. Basic usage example: a table without borders and headers with 5 columns and 2 rows, with 10 spaces of padding from the left:");
     TPrint::new(false, false, 10, 3).
         column_add("Name", TPrintAlign::Center, TPrintAlign::Left).
         column_add("Age", TPrintAlign::Center, TPrintAlign::Center).
@@ -58,6 +56,5 @@ fn main() {
         add_data("Madrid").
         add_data("Accountant").
         add_data("❤️😴🤦🏼‍♂️").
-        print();
-    println!();
+        print()
 }

examples/file_output.rs

@@ -43,7 +43,7 @@ fn main() -> io::Result<()> {
         f_tprint.add_data(file_date);
     }
 
-    f_tprint.print();
+    f_tprint.print()?;
 
     let output = fs::read_to_string(OUT_FILE)?;
     print!("{}", output);

examples/html_output.rs

@@ -4,7 +4,7 @@ use std::rc::Rc;
 
 const OUT_FILE: &str = "/tmp/tprint.html";
 
-fn main() {
+fn main() -> std::io::Result<()> {
     let output = Rc::new(RefCell::new(TPrintOutputFile::new(OUT_FILE).unwrap()));
     let borders = Rc::new(RefCell::new(TPrintBordersHTML {}));
     TPrint::new_with_borders_output(borders, output, true, true, 0, 1).
@@ -23,6 +23,5 @@ fn main() {
         add_data("Madrid").
         add_data("Accountant").
         add_data("❤️😴🤦🏼‍♂️").
-        print();
-    println!();
+        print()
 }

examples/string_output.rs

@@ -2,7 +2,7 @@ use tprint::{TPrint, TPrintAlign, TPrintOutputString, TPrintBordersUnicode};
 use std::cell::RefCell;
 use std::rc::Rc;
 
-fn main() {
+fn main() -> std::io::Result<()> {
     let str_output = Rc::new(RefCell::new(TPrintOutputString::new()));
     let borders = Rc::new(RefCell::new(TPrintBordersUnicode {}));
     let mut str_tprint = TPrint::new_with_borders_output(borders, str_output.clone(), true, true, 0, 1);
@@ -21,7 +21,9 @@ fn main() {
         str_tprint.add_data(j.pow(i).to_string());
         str_tprint.add_data(j.pow(MAX-i-1).to_string());
     }
-    str_tprint.print();
+    str_tprint.print()?;
 
     println!("{}", str_output.borrow().get_str());
+
+    Ok(())
 }

src/output.rs

@@ -4,7 +4,7 @@ use std::io::{self, Write};
 
 /// Defines the methods that a TPrintOutput object must implement.
 pub trait TPrintOutput {
-    fn print_str(&mut self, s: &str);
+    fn print_str(&mut self, s: &str) -> Result<(), io::Error>;
 }
 
 /// An struct that prints output to stdout (default).
@@ -13,8 +13,9 @@ pub struct TPrintOutputStdout {}
 impl TPrintOutputStdout {}
 
 impl TPrintOutput for TPrintOutputStdout {
-    fn print_str(&mut self, s: &str) {
+    fn print_str(&mut self, s: &str) -> Result<(), io::Error> {
         print!("{}", s);
+        Ok(())
     }
 }
 
@@ -44,8 +45,9 @@ impl Default for TPrintOutputString {
 }
 
 impl TPrintOutput for TPrintOutputString {
-    fn print_str(&mut self, s: &str) {
+    fn print_str(&mut self, s: &str) -> Result<(), io::Error> {
         self.str.push_str(s);
+        Ok(())
     }
 }
 
@@ -68,7 +70,7 @@ impl TPrintOutputFile {
 }
 
 impl TPrintOutput for TPrintOutputFile {
-    fn print_str(&mut self, s: &str) {
-        self.f.write_all(s.as_bytes()).unwrap();
+    fn print_str(&mut self, s: &str) -> io::Result<()> {
+        self.f.write_all(s.as_bytes())
     }
 }