Jon Portnoy > List-Objects-WithUtils-1.012001 > List::Objects::WithUtils::Array::Typed

Download:
List-Objects-WithUtils-1.012001.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.012001   Source   Latest Release: List-Objects-WithUtils-2.017002

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 ^

A List::Objects::WithUtils::Array subclass providing type-checking via Type::Tiny types.

This module requires Type::Tie.

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/;

Elements are checked against the specified type when the object is constructed or new elements are added.

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

Values that cannot be coerced will throw an exception.

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

It's worth noting that this comes with the obvious type-checking performance hit, plus some extra overhead in proxying array operations.

type

Returns the Type::Tiny type the object was created with.

AUTHOR ^

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

syntax highlighting: