X::OutOfRange

Author: moritz

lib/X/OutOfRange.pod

@@ -0,0 +1,38 @@
+=begin pod
+
+=TITLE class X::OutOfRange
+
+    class X::OutOfRange is Exception { }
+
+General error when something (for example an array index) is out of an allowed
+range.
+
+=head1 Methods
+
+=head2 what
+
+    method what() returns Str:D
+
+Verbal description of the thing that was out of range (e.g. C<"array index">,
+C<"month">).
+
+=head2 got
+
+    method got()
+
+Returns the object that was considered out of range (often an integer)
+
+=head2 range
+
+    method range returns Range:D
+
+Returns a L<Range> object describing the premissible range for the object
+returned from C<.got>.
+
+=head2 comment
+
+    method comment returns Str
+
+Returns an additiona comment that is included in the error message.
+
+=end pod