class X::TypeCheck::Assignment

Error due to a failed type check during assignment

class X::TypeCheck::Assignment is X::TypeCheck { }

Error class thrown when the type check of an assignment fails.

For example, this will die

my Int $x = "foo";
CATCH { default { put .^name''.Str } };
# OUTPUT: «X::TypeCheck::Assignment: Type check failed in assignment to $x; expected Int but got Str ("foo")␤» 

though compilers are allowed to detect obvious cases like this example and complain at compile time with a different error.

Type Graph

Type relations for X::TypeCheck::Assignment
perl6-type-graph X::TypeCheck::Assignment X::TypeCheck::Assignment X::TypeCheck X::TypeCheck X::TypeCheck::Assignment->X::TypeCheck Mu Mu Any Any Any->Mu Exception Exception Exception->Any X::TypeCheck->Exception

Expand above chart

Routines supplied by class X::TypeCheck

X::TypeCheck::Assignment inherits from class X::TypeCheck, which provides the following routines:

(X::TypeCheck) method operation

method operation(--> Str:D)

Returns a string description of the operation that failed, for example "assignment", "binding", "return".

(X::TypeCheck) method got

method got()

Returns the object that failed to type check

(X::TypeCheck) method expected

method expected()

Returns the type object against which the check failed.

Routines supplied by class Exception

X::TypeCheck::Assignment inherits from class Exception, which provides the following routines:

(Exception) method message

Defined as:

method message(Exception:D: --> Str:D)

This is a stub that must be overwritten by subclasses, and should return the exception message.

Special care should be taken that this method does not produce an exception itself.

try die "Something bad happened";
if ($!{
    say $!.message# OUTPUT: «Something bad happened.␤» 
}

(Exception) method backtrace

Defined as:

method backtrace(Exception:D: --> Backtrace:D)

Returns the backtrace associated with the exception. Only makes sense on exceptions that have been thrown at least once.

try die "Something bad happened";
if ($!{
    print $!.backtrace;
}

(Exception) method throw

Defined as:

method throw(Exception:D:)

Throws the exception.

my $exception = X::AdHoc.new;    # Totally fine 
try $exception.throw;            # Throws 
if ($!{ #`( some handling ) }# Suppress the exception 

(Exception) method resume

Defined as:

method resume(Exception:D:)

Resumes control flow where .throw left it when handled in a CATCH block.

# For example, resume control flow for any exception 
CATCH { default { .resume } }

(Exception) method rethrow

Defined as:

method rethrow(Exception:D:)

Rethrows an exception that has already been thrown at least once. This is different from throw in that it preserves the original backtrace.

my $e = X::AdHoc.new(payload => "Bad situation");
sub f() { die 'Bad' };
sub g() { try fCATCH { default { .rethrow } } };
g;
CATCH { default { say .backtrace.full } };

(Exception) method fail

Defined as:

multi sub    fail(*@text)
multi sub    fail(Exception $e)
method fail(Exception:D:)

Exits the calling Routine and returns a Failure object wrapping the exception $e - or, for the *@text form, an X::AdHoc exception constructed from the concatenation of @text. If the caller activated fatal exceptions via the pragma use fatal;, the exception is thrown instead of being returned as a Failure.

sub copy-directory-tree ($dir{
    fail "$dir is not a directory" if !$dir.IO.d;
    ...
}

(Exception) method gist

Defined as:

multi method gist(Exception:D:)

Returns whatever the exception printer should produce for this exception. The default implementation returns message and backtrace separated by a newline.

my $e = X::AdHoc.new(payload => "This exception is pretty bad");
try $e.throw;
if ($!{ say $!.gist};
# OUTPUT: «This exception is pretty bad 
#   in block <unit> at <unknown file> line 1␤» 

(Exception) sub die

Defined as:

multi sub die()
multi sub die(*@message)
multi sub die(Exception:D $e)
method    die(Exception:D:)

Throws a fatal Exception. The default exception handler prints each element of the list to $*ERR (STDERR).

die "Important reason";

If the subroutine form is called without arguments, the value of $! variable is checked. If it is set to a .DEFINITE value, its value will be used as the Exception to throw if it's of type Exception, otherwise, it will be used as payload of X::AdHoc exception. If $! is not .DEFINITE, X::AdHoc with string "Died" as payload will be thrown.

die will print by default the line number where it happens

die "Dead";
# OUTPUT: «(exit code 1) Dead␤ 
# in block <unit> at /tmp/nH_B3Fq_zU line 1␤␤» 

However, that default behavior is governed at the Exception level and thus can be changed to anything we want by capturing the exception using CATCH. This can be used, for instance, to suppress line numbers.

CATCH {
  default {
    .payload.say
  }
};
die "Dead" # OUTPUT: «Dead␤» 

(Exception) sub warn

Defined as:

multi sub warn(*@message)

Throws a resumable warning exception, which is considered a control exception, and hence is invisible to most normal exception handlers. The outermost control handler will print the warning to $*ERR. After printing the warning, the exception is resumed where it was thrown. To override this behavior, catch the exception in a CONTROL block. A quietly {...} block is the opposite of a try {...} block in that it will suppress any warnings but pass fatal exceptions through.

To simply print to $*ERR, please use note instead. warn should be reserved for use in threatening situations when you don't quite want to throw an exception.

warn "Warning message";