f

CosmicHorrorDev · Nov 20, 2024 · f0df280 · f0df280
1 parent ee9a90b
commit f0df280
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/keyvalues-parser/src/error.rs b/keyvalues-parser/src/error.rs
@@ -54,6 +54,17 @@ impl ParseError {
         self.inner
     }
 
+    /// The span indicating where the error is in the original text
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # use keyvalues_parser::Vdf;
+    /// let vdf_text = "key value >:V extra bytes";
+    /// let err = Vdf::parse(vdf_text).unwrap_err();
+    /// let error_snippet = err.index_span().slice(vdf_text);
+    /// assert_eq!(error_snippet, ">:V extra bytes");
+    /// ```
     pub fn index_span(&self) -> Span<usize> {
         self.index_span.clone()
     }