lib/Moose/Cookbook/Snack/Types.pod

   1 package Moose::Cookbook::Snack::Types;
   2
   3 # ABSTRACT: Snippets of code for using Types and Type Constraints
   4
   5 __END__
   6
   7
   8 =pod
   9
  10 =head1 SYNOPSIS
  11
  12   package Point;
  13   use Moose;
  14
  15   has 'x' => ( isa => 'Int', is => 'ro' );
  16   has 'y' => ( isa => 'Int', is => 'rw' );
  17
  18   package main;
  19   use Try::Tiny;
  20
  21   my $point = try {
  22       Point->new( x => 'fifty', y => 'forty' );
  23   }
  24   catch {
  25       print "Oops: $_";
  26   };
  27
  28   my $point;
  29   my $xval             = 'forty-two';
  30   my $xattribute       = Point->meta->find_attribute_by_name('x');
  31   my $xtype_constraint = $xattribute->type_constraint;
  32
  33   if ( $xtype_constraint->check($xval) ) {
  34       $point = Point->new( x => $xval, y => 0 );
  35   }
  36   else {
  37       print "Value: $xval is not an " . $xtype_constraint->name . "\n";
  38   }
  39
  40 =head1 DESCRIPTION
  41
  42 This is the Point example from
  43 L<Moose::Cookbook::Basics::Point_AttributesAndSubclassing> with type checking
  44 added.
  45
  46 If we try to assign a string value to an attribute that is an C<Int>,
  47 Moose will die with an explicit error message. The error will include
  48 the attribute name, as well as the type constraint name and the value
  49 which failed the constraint check.
  50
  51 We use L<Try::Tiny> to catch this error message.
  52
  53 Later, we get the L<Moose::Meta::TypeConstraint> object from a
  54 L<Moose::Meta::Attribute> and use the L<Moose::Meta::TypeConstraint>
  55 to check a value directly.
  56
  57 =head1 SEE ALSO
  58
  59 =over 4
  60
  61 =item L<Moose::Cookbook::Basics::Point_AttributesAndSubclassing>
  62
  63 =item L<Moose::Utils::TypeConstraints>
  64
  65 =item L<Moose::Meta::Attribute>
  66
  67 =back
  68
  69 =cut