The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.


Test::Stream::Compare::Array - Internal representation of an array comparison.


This distribution is deprecated in favor of Test2, Test2::Suite, and Test2::Workflow.

See Test::Stream::Manual::ToTest2 for a conversion guide.


This module is an internal representation of an array for comparison purposes.


$ref = $arr->inref()

If the instance was constructed from an actual array, this will have the reference to that array.

$bool = $arr->ending

Set this to true if you would like to fail when the array being validated has more items than the check. That is if you check indexes 0-3, but the array received has values for indexes 0-4, it will fail and list that last item in the array as unexpected. If this is false then it is assumed you do not care about extra items.

$hashref = $arr->items()

This gives you the hashref of key => val pairs to be checked in the array. This is a hashref so that indexes can be skipped if desired.

Note: that there is no validation when using set_items, it is better to use the add_item interface.

$arrayref = $arr->order()

This gives you an arrayref of all indexes that will be checked, in order.

Note: that there is no validation when using set_order, it is better to use the add_item interface.

$name = $arr->name()

Always returns the string "<ARRAY>".

$bool = $arr->verify(got => $got, exists => $bool)

Check if $got is an array reference or not.

$idx = $arr->top_index()

Get the topmost index that gets checked. This will return undef if there are no items, 0 is returned if there is only 1 item.

$arr->add_item($idx => $item)

Add an item to the list of values to check. If index is omitted then the next index after the last is used.

$arr->add_filter(sub { ... })

Add a filter sub. The filter receives all remaining values of the array being checked, and should return the values that should still be checked. The filter will be run between the last item added and the next item added.

@deltas = $arr->deltas(got => $got, convert => \&convert, seen => \%seen)

Find the differences between the expected array values and those in the $got arrayref.


The source code repository for Test::Stream can be found at


Chad Granum <>


Chad Granum <>


Copyright 2015 Chad Granum <>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.