NAME

List::Objects::WithUtils::Array::Typed - Type-checking array objects

SYNOPSIS

  use List::Objects::WithUtils 'array_of';

  use Types::Standard -all;
  use List::Objects::Types -all;

  my $arr = array_of( Int() => 1 .. 10 );
  $arr->push('foo');    # dies, failed type check
  $arr->push(11 .. 15); # ok

  my $arr_of_arrs = array_of( ArrayObj );
  $arr_of_arrs->push([], []); # ok, coerces to ArrayObj

DESCRIPTION

These are type-checking array objects; elements are checked against the specified type when the object is constructed or new elements are added.

The first argument passed to the constructor should be a Type::Tiny type:

  use Types::Standard -all;
  my $arr = array_of Str() => qw/foo bar baz/;

If the initial type-check fails, a coercion is attempted.

This class consumes the following roles, which contain most of the relevant documentation:

List::Objects::WithUtils::Role::Array

List::Objects::WithUtils::Role::Array::WithJunctions

List::Objects::WithUtils::Role::Array::Typed

Also see Types::Standard, List::Objects::Types

AUTHOR

Jon Portnoy <avenj@cobaltirc.org> with significant contributions from Toby Inkster (CPAN: TOBYINK)