Jon Portnoy > List-Objects-WithUtils-1.012001 > List::Objects::WithUtils::Hash::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.021001

NAME ^

List::Objects::WithUtils::Hash::Typed - Type-checking hash objects

SYNOPSIS ^

  use List::Objects::WithUtils 'hash_of';
  use Types::Standard -all;

  my $arr = hash_of(Int, foo => 1, bar => 2);
  $arr->set(baz => 3.14159);    # dies, failed type check

DESCRIPTION ^

A List::Objects::WithUtils::Hash 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 = hash_of ArrayRef() => (foo => [], bar => []);

Values 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.

type

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

AUTHOR ^

Jon Portnoy <avenj@cobaltirc.org>; typed hashes implemented by Toby Inkster (CPAN: TOBYINK)

syntax highlighting: