Implemented position and line for all the Errors

+ General refactoring
+ Minor improvements
+ Added missing docs

README.md

@@ -16,7 +16,7 @@ Add the dependency to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-gura = "0.4.2"
+gura = "0.5.0"
 ```
 
 

examples/errors.rs

@@ -1,4 +1,3 @@
-// Basic Gura parser usage example
 use gura::{errors::Error, parse};
 
 fn main() {
@@ -9,7 +8,7 @@ title: "Gura Example"
 some_invalid: $non_existent_var 
 "##;
 
-    // Parse: transforms a Gura string into a dictionary
+    // Checks parsing result
     match parse(&gura_string) {
         Ok(parsed) => {
             println!("Title -> {}", parsed["title"]);

src/errors.rs

@@ -1,5 +1,6 @@
 use std::fmt;
 
+/// All Gura error variants
 #[derive(Debug, PartialEq)]
 pub enum Error {
     /// Raises when Gura syntax is invalid
@@ -21,23 +22,23 @@ pub enum Error {
 /// A Gura error with position, line and custom message
 #[derive(Debug, PartialEq)]
 pub struct GuraError {
-    pub pos: usize,
+    pub pos: isize,
     pub line: usize,
     pub msg: String,
-    pub kind: Error, // TODO: rename to type
+    pub kind: Error,
 }
 
 impl fmt::Display for GuraError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         write!(
             f,
-            "{} at line {} position {}",
+            "{} at line {} (text position = {})",
             self.msg, self.line, self.pos
         )
     }
 }
 
-// ValueError (for internal usage)
+/// ValueError (for internal usage)
 #[derive(Debug)]
 pub struct ValueError {}
 

src/lib.rs

@@ -78,6 +78,47 @@
 //! println!("\n+++++ Dump result +++++");
 //! println!("{}", object_string);
 //! ```
+//! 
+//! ## Working with errors
+//! 
+//! One of Gura's strengths is the standardization of errors. Now you can find the type and position of the problem directly:
+//! ```
+//! use gura::{errors::Error, parse};
+//! 
+//! fn main() {
+//!     let gura_string = r##"
+//! # This is a Gura document.
+//! title: "Gura Example"
+//! 
+//! some_invalid: $non_existent_var 
+//! "##;
+//! 
+//!     // Checks parsing result
+//!     match parse(&gura_string) {
+//!         Ok(parsed) => {
+//!             println!("Title -> {}", parsed["title"]);
+//!         }
+//!         Err(e) => {
+//!             println!("Error: {}", e); // Error implements fmt::Display
+//! 
+//!             match e.kind {
+//!                 Error::ParseError => println!("Syntax is wrong!"),
+//!                 Error::VariableNotDefinedError => println!("A non defined variable was used! "),
+//!                 Error::InvalidIndentationError => println!("Indentation is invalid!"),
+//!                 Error::DuplicatedVariableError => {
+//!                     println!("A variable was defined more than once!")
+//!                 }
+//!                 Error::DuplicatedKeyError => println!("A key was defined more than once!"),
+//!                 Error::FileNotFoundError => println!("An imported file does not exist!"),
+//!                 Error::DuplicatedImportError => {
+//!                     println!("The same Gura file was imported more than once!")
+//!                 }
+//!             }
+//!         }
+//!     }
+//! }
+//! ```
+
 
 pub mod errors;
 pub mod macros;