Rules / Types, classes & roles / basic

IntStr Reference

Dual value integer and string

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 new #

method new(Int $i, Str $s)

The constructor requires both the Int and the Str value, when constructing one directly the values can be whatever is required:

method Int #

method Int

Returns the integer value of the IntStr.

method Numeric #

multi method Numeric(IntStr:D: --> Int:D)
multi method Numeric(IntStr:U: --> Int:D)

Returns Int:D.

The :D variant returns the numeric portion of the invocant. The :U variant issues a warning about using an uninitialized value in numeric context and then returns value 0.

method Real #

multi method Real(IntStr:D: --> Int:D)
multi method Real(IntStr:U: --> Int:D)

Returns Int:D.

The :D variant returns the numeric portion of the invocant. The :U variant issues a warning about using an uninitialized value in numeric context and then returns value 0.

infix C«===» #

multi infix:<===>(IntStr:D $a, IntStr:D $b)

IntStr Value identity operator. Returns True if the Int values of $a and $b are identical and their Str values are also identical. Returns False otherwise.

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 doc-drift · 1 no-output · 1 ok

class IntStr is Allomorph is Int { }

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

my $int-str = <42>;
say $int-str.^name;     # OUTPUT: «IntStr␤»

my Int $int = $int-str; # OK!
my Str $str = $int-str; # OK!

# ∈ operator cares about object identity
say 42 ∈ <42  55  1>;   # OUTPUT: «False␤»
Output
IntStr
False

Documentation, Rakudo and Raku++ all agree.

my $f = IntStr.new(42, "forty two");
say +$f; # OUTPUT: «42␤»
say ~$f; # OUTPUT: «"forty two"␤»
Documentation
42
"forty two"
Rakudo
42
forty two
Raku++
42
forty two

Both engines agree; the documentation states something else. Trust the engines.