Rules / Types, classes & roles / exception

X::OutOfRange Reference

Error due to indexing outside of an allowed range

What it is #

Routines #

Signatures are reproduced from the documentation, including their declared return types. A routine listed here is part of the type's published interface; whether Raku++ implements it is a separate question, answered by the examples below.

method what #

method what(--> Str:D)

Returns Str:D.

Verbal description of the thing that was out of range (e.g. "array index", "month").

method got #

method got()

Returns the object that was considered out of range (often an integer)

method range #

method range(--> Range:D)

Returns Range:D.

Returns a Range object describing the permissible range for the object returned from .got.

method comment #

method comment(--> Str)

Returns Str.

Returns an additional comment that is included in the error message.

Examples, run three ways #

Every example below comes from the official documentation, together with the output that documentation asserts. Each was then executed by Rakudo and by Raku++ when this page was built. Where the three agree, one result is shown; where they do not, all three are — because which of them is wrong is exactly the information worth having.

1 no-output · 1 rakupp-differs

class X::OutOfRange is Exception { }

Not executed: the documentation states no expected output for this example.

say 42[2];
CATCH { default { put .^name, ': ', .Str } };
# OUTPUT: «X::OutOfRange: Index out of range. Is: 2, should be in 0..0␤»
Documentation
X::OutOfRange: Index out of range. Is: 2, should be in 0..0
Rakudo
X::OutOfRange: Index out of range. Is: 2, should be in 0..0
Raku++
Nil

Raku++ disagrees with both the documentation and Rakudo — a defect.