NAME

List::Objects::WithUtils::Role::Hash::Typed - Type-checking hash behavior

SYNOPSIS

  # Via List::Objects::WithUtils::Hash::Typed ->
  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

This role makes use of Type::Tie to add type-checking behavior to List::Objects::WithUtils::Role::Hash consumers.

The first argument passed to the constructor should be a Type::Tiny type (or other object conforming to Type::API, as of "v2.25"):

  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

type

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

untyped

Returns a (shallow) clone that is a plain List::Objects::WithUtils::Hash.

AUTHOR

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