File Coverage

blib/lib/Object/Pad/FieldAttr/Isa.pm

Criterion	Covered	Total	%
statement	9	10	90.0
branch			n/a
condition			n/a
subroutine	4	5	80.0
pod			n/a
total	13	15	86.6

#  You may distribute under the terms of either the GNU General Public License
#  or the Artistic License (the same terms as Perl itself)
#
#  (C) Paul Evans, 2021-2023 -- [e-mail]

package Object::Pad::FieldAttr::Isa 0.05;

use v5.14;
use warnings;

use Object::Pad 0.802;

require XSLoader;
XSLoader::load( __PACKAGE__, our $VERSION );

=head1 NAME

C - apply class type constraints to C fields

=head1 SYNOPSIS

   use Object::Pad;
   use Object::Pad::FieldAttr::Isa;

   class ListNode {
      field $next :param :reader :writer :Isa(ListNode) = undef;
   }

   my $first = ListNode->new();
   my $second = ListNode->new(next => $first);

   # This will fail
   my $third = ListNode->new(next => "something else");

   # This will fail
   $second->set_next("another thing");

=head1 DESCRIPTION

This module provides a third-party field attribute for L-based
classes, which declares that values assigned to the field must conform to a
given object type.

B The ability for L to take third-party field attributes
is still new and highly experimental, and subject to much API change in
future. As a result, this module should be considered equally experimental.

=head1 FIELD ATTRIBUTES

=head2 :Isa

   field $name :Isa(CLASSNAME) ...;

Declares that any value assigned to the field must be an object reference,
and must be derived from the named class. Attempts to assign a non-conforming
value, such as a non-reference, or reference to a class not derived from that
named, will throw an exception, and the field value will not be modified.

This type constraint is applied whenever the field itself is assigned to,
whether that is from C<:param> initialisation, invoking a C<:writer> or
C<:mutator> accessor, or direct assignment into the field variable by method
code within the class.

=cut

sub import
{
   $^H{"Object::Pad::FieldAttr::Isa/Isa"}++;
}

sub unimport
{
   delete $^H{"Object::Pad::FieldAttr::Isa/Isa"};
}

=head1 AUTHOR

Paul Evans

=cut

0x55AA;