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

DESCRIPTION

These are type-checking hash objects; values 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 $hash = hash_of Int() => ( foo => 1 );

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::Hash

List::Objects::WithUtils::Role::Hash::Typed

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

hash_of

Creates a new typed hash object.

AUTHOR

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