manpagez: man pages & more
man Error::TypeTiny::Assertion(3)
Home | html | info | man
Error::TypeTiny::Assertion(3)              User Contributed Perl Documentation



NAME

       Error::TypeTiny::Assertion - exception when a value fails a type
       constraint


STATUS

       This module is covered by the Type-Tiny stability policy.


DESCRIPTION

       This exception is thrown when a value fails a type constraint
       assertion.

       This package inherits from Error::TypeTiny; see that for most
       documentation. Major differences are listed below:

   Attributes
       "type"
           The type constraint that was checked against. Weakened links are
           involved, so this may end up being "undef".

       "value"
           The value that was tested.

       "varname"
           The name of the variable that was checked, if known. Defaults to
           '$_'.

       "attribute_name"
           If this exception was thrown as the result of an isa check or a
           failed coercion for a Moo attribute, then this will tell you which
           attribute (if your Moo is new enough).

           (Hopefully one day this will support other OO frameworks.)

       "attribute_step"
           If this exception was thrown as the result of an isa check or a
           failed coercion for a Moo attribute, then this will contain either
           "isa check" or "coercion" to indicate which went wrong (if your Moo
           is new enough).

           (Hopefully one day this will support other OO frameworks.)

   Methods
       "has_type", "has_attribute_name", "has_attribute_step"
           Predicate methods.

       "message"
           Overridden to add "varname" to the message if defined.

       "explain"
           Attempts to explain why the value did not pass the type constraint.
           Returns an arrayref of strings providing step-by-step reasoning; or
           returns undef if no explanation is possible.


BUGS

       Please report any bugs to
       <https://github.com/tobyink/p5-type-tiny/issues>.


SEE ALSO

       Error::TypeTiny(3).


AUTHOR

       Toby Inkster <tobyink@cpan.org>.


COPYRIGHT AND LICENCE

       This software is copyright (c) 2013-2014, 2017-2025 by Toby Inkster.

       This is free software; you can redistribute it and/or modify it under
       the same terms as the Perl 5 programming language system itself.


DISCLAIMER OF WARRANTIES

       THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
       WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
       MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

perl v5.34.3                      2025-05-03     Error::TypeTiny::Assertion(3)

type-tiny 2.8.2 - Generated Tue Aug 5 05:21:59 CDT 2025
© manpagez.com 2000-2025
Individual documents may contain additional copyright information.