docs: add docs about full match (#74)

Co-authored-by: Randolf J <19544887-randolf@users.noreply.gitlab.com>

README.md

@@ -45,6 +45,9 @@ assert_eq!(
 );
 assert_eq!((subject, object), (Some("name"), Some("Rho")));
 
+// If you want to ensure the entire string matches, you can add `true` to the end of the macro.
+assert_eq!(unformat!("{1} is {0}", value, true), None);
+
 // If a type implements `FromStr`, you can use it as a type argument. This
 // is written as `{:Type}`.
 assert_eq!(

tests/unformat.rs

@@ -74,3 +74,14 @@ fn test_declmacro() {
 
     test_declmacro!("abc", "abcd");
 }
+
+#[test]
+fn test_full_match() {
+    assert_eq!(unformat!("({:u8}, {:u8})", "(1, 2)"), Some((1, 2)));
+    assert_eq!(unformat!("({:u8}, {:u8})", "(1, 2)bar"), Some((1, 2)));
+    assert_eq!(unformat!("({:u8}, {:u8})", "foo(1, 2)"), Some((1, 2)));
+
+    assert_eq!(unformat!("({:u8}, {:u8})", "(1, 2)", true), Some((1, 2)));
+    assert_eq!(unformat!("({:u8}, {:u8})", "(1, 2)bar", true), None);
+    assert_eq!(unformat!("({:u8}, {:u8})", "foo(1, 2)", true), None);
+}