Merge #397

397: adjust ParseError for indicating if an urn format was expected r=Dylan-DPC a=kinggoesgaming

**I'm submitting a(n)** refactor

# Description
Allows for future parsing ability for the adapters.

# Motivation
This was a breaking change as such was needed to be added in 0.8.0`

# Tests
Current tests should pass. No new tests introduced.

# Related Issue(s)
closes #370 


Co-authored-by: Hunar Roop Kahlon <[email protected]>

src/lib.rs

@@ -841,6 +841,7 @@ impl Uuid {
                             expected: "0123456789abcdefABCDEF-",
                             found: input[i_char..].chars().next().unwrap(),
                             index: i_char,
+                            urn: parser::UrnPrefix::Optional,
                         });
                     }
                 }
@@ -875,6 +876,7 @@ impl Uuid {
                             expected: "0123456789abcdefABCDEF-",
                             found: input[i_char..].chars().next().unwrap(),
                             index: i_char,
+                            urn: parser::UrnPrefix::Optional,
                         });
                     }
                 }
@@ -1066,6 +1068,7 @@ mod tests {
                 expected: EXPECTED_CHARS,
                 found: 'G',
                 index: 20,
+                urn: parser::UrnPrefix::Optional,
             })
         );
 
@@ -1107,6 +1110,7 @@ mod tests {
                 expected: EXPECTED_CHARS,
                 found: 'X',
                 index: 18,
+                urn: parser::UrnPrefix::Optional,
             })
         );
 
@@ -1159,6 +1163,7 @@ mod tests {
                 expected: EXPECTED_CHARS,
                 found: '%',
                 index: 15,
+                urn: parser::UrnPrefix::Optional,
             })
         );
 
@@ -1212,6 +1217,7 @@ mod tests {
                 expected: EXPECTED_CHARS,
                 found: 'X',
                 index: 6,
+                urn: parser::UrnPrefix::Optional,
             })
         );
         assert_eq!(

src/parser/core_support.rs

@@ -39,8 +39,23 @@ impl fmt::Display for parser::ParseError {
                 expected,
                 found,
                 index,
+                urn,
             } => {
-                write!(f, "expected {}, found {} at {}", expected, found, index)
+                let urn_str = match urn {
+                    parser::UrnPrefix::None => "",
+                    parser::UrnPrefix::Optional => {
+                        " an optional prefix of `urn:uuid:` followed by"
+                    }
+                    parser::UrnPrefix::Required => {
+                        " a prefix of `urn:uuid` followed by"
+                    }
+                };
+
+                write!(
+                    f,
+                    "expected{} {}, found {} at {}",
+                    urn_str, expected, found, index
+                )
             }
             parser::ParseError::InvalidGroupCount {
                 ref expected,

src/parser/mod.rs

@@ -33,6 +33,17 @@ pub enum Expected {
     },
 }
 
+/// Urn prefix value.
+#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+pub enum UrnPrefix {
+    /// No `urn:uuid:` prefix should be provided.
+    None,
+    /// The `urn:uuid:` prefix should optionally provided.
+    Optional,
+    /// The `urn:uuid:` prefix is required.
+    Required,
+}
+
 /// An error that can occur while parsing a [`Uuid`] string.
 ///
 /// [`Uuid`]: ../struct.Uuid.html
@@ -48,6 +59,12 @@ pub enum ParseError {
         found: char,
         /// The invalid character position.
         index: usize,
+        /// Indicates the [`Uuid`] starts with `urn:uuid:`.
+        ///
+        /// This is a special case for [`Urn`] adapter parsing.
+        ///
+        /// [`Uuid`]: ../Uuid.html
+        urn: UrnPrefix,
     },
     /// Invalid number of segments in the [`Uuid`] string.
     ///