X::Str::Numeric

Author: moritz

lib/X/Str/Numeric.pod

@@ -0,0 +1,38 @@
+=begin pod
+
+=TITLE class X::Str::Numeric
+
+    class X::Str::Numeric is Exception { }
+
+Error thrown (or wrapped in a C<Failure>) when a a conversion from string to
+a number fails.
+
+For example
+
+    say +"42 answers"
+
+dies with
+
+    Cannot convert string to number: trailing characters after number in '42⏏ answers' (indicated by ⏏)
+
+=head1 Methods
+
+=head2 source
+
+    method source() returns Str:D
+
+Returns the string that was attempted to convert to a number
+
+=head2 pos
+
+    method pos() returns Int:D
+
+Gives the position into the string where the parsing failed.
+
+=head2 reason
+
+    method reason() returns Int:D
+
+Verbal description of the reason why the conversion failed.
+
+=end pod